mc.json

{
  "openrpc": "1.2.1",
  "info": {
    "title": "IBSng: branch D: mc",
    "version": "1.0.0"
  },
  "methods": [
    {
      "name": "mc.getAllMSGTypes",
      "description": "",
      "auth_type": ["ADMIN", "NORMAL_USER", "VOIP_USER"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.getActiveMSGTypes",
      "description": "",
      "auth_type": ["ADMIN", "NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "view_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["SEND", "REPORT"]
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.getProviderTypes",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "list of provider types",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.getProviderInfoByName",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "provider_name": {
              "title": "",
              "type": "string"
            },
            "provider_id": {
              "title": "",
              "type": "integer"
            },
            "owner_isp_id": {
              "title": "",
              "type": "integer"
            },
            "provider_type": {
              "title": "",
              "type": "string",
              "enum": [
                "Parspooyesh",
                "Pishgaman",
                "Rahyab",
                "I-Email",
                "ADP",
                "Generic-HTTP",
                "IBSngMessaging",
                "Magfa",
                "MihanSMSCenter",
                "AsreFaraErtebat",
                "AFE-WS"
              ]
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            }
          }
        }
      }
    },
    {
      "name": "mc.getProviderAttrsByName",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object"
        }
      }
    },
    {
      "name": "mc.addNewProvider",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "Parspooyesh",
              "Pishgaman",
              "Rahyab",
              "I-Email",
              "ADP",
              "Generic-HTTP",
              "IBSngMessaging",
              "Magfa",
              "MihanSMSCenter",
              "AsreFaraErtebat",
              "AFE-WS"
            ]
          }
        },
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "msg_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "provider_name": {
              "title": "",
              "type": "string"
            },
            "provider_id": {
              "title": "",
              "type": "integer"
            },
            "owner_isp_id": {
              "title": "",
              "type": "integer"
            },
            "provider_type": {
              "title": "",
              "type": "string",
              "enum": [
                "Parspooyesh",
                "Pishgaman",
                "Rahyab",
                "I-Email",
                "ADP",
                "Generic-HTTP",
                "IBSngMessaging",
                "Magfa",
                "MihanSMSCenter",
                "AsreFaraErtebat",
                "AFE-WS"
              ]
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            }
          }
        }
      }
    },
    {
      "name": "mc.updateProviderAttrs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "to_update_attrs",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.getAllActiveProviders",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "list of Provide Info dictionaries",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.removeProvider",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.resetProviderAttrs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.addNewEPGroupToProvider",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "end_point_range",
          "description": "comma-seperated end-point groups",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.getAllEPGroupsOfProvider",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "list of end-point groups",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.getProviderUnassignedEPs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "count",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "starts_with",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "list of end-point groups",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.unAssingAllFromGroup",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "end_point_group_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.removeEPGroupFromProvider",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "provider_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "end_point_group_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.getEPGroupUsageInfo",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE PROVIDERS"],
      "params": [
        {
          "name": "end_point_group_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "provider_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "end_point_id": {
              "title": "",
              "type": "integer"
            },
            "end_point_group_id": {
              "title": "",
              "type": "integer"
            },
            "end_point_repr": {
              "title": "",
              "type": "string"
            },
            "assigned_user_id": {
              "title": "",
              "type": "integer"
            }
          }
        }
      }
    },
    {
      "name": "mc.receive",
      "description": "",
      "auth_type": ["ADMIN", "NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "msg_info",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "dst": {
                "title": "list of destinations",
                "type": "array"
              },
              "msg_type": {
                "title": "",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              },
              "from": {
                "title": "source (sender) address (phone number / email)",
                "type": "string"
              },
              "body": {
                "title": "",
                "type": "string"
              }
            }
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.enqueueSend",
      "description": "without schedule_date",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "body",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "destinations",
          "description": "comma-seperated list of destinations",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "msg_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.enqueueSend",
      "description": "with schedule_date",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "body",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "destinations",
          "description": "comma-seperated list of destinations",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "msg_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
          }
        },
        {
          "name": "schedule_date",
          "description": "datetime or number, ",
          "schema": {
            "type": ["string", "number"]
          }
        },
        {
          "name": "schedule_date_unit",
          "schema": {
            "type": "string",
            "enum": [
              "jalali",
              "gregorian",
              "years",
              "months",
              "days",
              "hours",
              "minutes"
            ]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.adminEnqueueSend",
      "description": "without schedule_date",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "body",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "destinations",
          "description": "comma-seperated list of destinations",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "msg_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.adminEnqueueSend",
      "description": "with schedule_date",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "body",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "destinations",
          "description": "comma-seperated list of destinations",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "msg_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
          }
        },
        {
          "name": "schedule_date",
          "description": "datetime or number, ",
          "schema": {
            "type": ["string", "number"]
          }
        },
        {
          "name": "schedule_date_unit",
          "schema": {
            "type": "string",
            "enum": [
              "jalali",
              "gregorian",
              "years",
              "months",
              "days",
              "hours",
              "minutes"
            ]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.activateService",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "cell_number",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (boolean)",
        "summary": "returns true, or raises an error",
        "schema": {
          "title": "",
          "type": "boolean"
        }
      }
    },
    {
      "name": "mc.resetUserActivationCode",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.checkActivationCode",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "activation_code",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (boolean)",
        "summary": "returns true, or raises an error",
        "schema": {
          "title": "",
          "type": "boolean"
        }
      }
    },
    {
      "name": "mc.getUserActivationNumber",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "activation_number": {
              "title": "cell_phone of user",
              "type": "string"
            }
          }
        }
      }
    },
    {
      "name": "mc.userSearchReceivedMessage",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "receive_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "receive_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "receive_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "receive_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "from": {
                "title": "source (sender) address (phone number / email)",
                "type": "string",
                "required": false
              },
              "from_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "page start index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "page end index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.adminSearchReceivedMessage",
      "description": "Messages of Users",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "owner_type": {
                "title": "",
                "enum": ["USER"]
              },
              "user_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "user_deleted": {
                "title": "",
                "type": "boolean",
                "required": false
              },
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "receive_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "receive_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "receive_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "receive_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "from": {
                "title": "source (sender) address (phone number / email)",
                "type": "string",
                "required": false
              },
              "from_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "page start index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "page end index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.adminSearchReceivedMessage",
      "description": "Messages of ISP",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "owner_type": {
                "title": "",
                "type": "string",
                "enum": ["ISP"]
              },
              "isp_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "receive_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "receive_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "receive_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "receive_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "from": {
                "title": "source (sender) address (phone number / email)",
                "type": "string",
                "required": false
              },
              "from_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "page start index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "page end index",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "mc.userSearchSentMessage",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "transfer_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "transfer_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "transfer_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "transfer_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "to": {
                "title": "destination address (phone number/email)",
                "type": "string",
                "required": false
              },
              "to_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "message_pack_id": {
              "title": "",
              "type": "integer"
            },
            "message_id": {
              "title": "",
              "type": "integer"
            },
            "failed": {
              "title": "",
              "type": "boolean"
            },
            "fail_reason": {
              "title": "",
              "type": "string"
            },
            "tracking_id": {
              "title": "",
              "type": "string"
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            },
            "user_id": {
              "title": "",
              "type": "integer"
            },
            "transfer_date": {
              "title": "date type (gregorian/jalali) depends on input date_type",
              "type": "string"
            },
            "source": {
              "title": "source (sender) address (phone number / email)",
              "type": "string"
            },
            "destination": {
              "title": "destination address (phone number / email)",
              "type": "string"
            },
            "body": {
              "title": "",
              "type": "string"
            },
            "consumed_credit": {
              "title": "",
              "type": "number"
            }
          }
        }
      }
    },
    {
      "name": "mc.adminSearchSentMessage",
      "description": "Messages of Users",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "owner_type": {
                "title": "",
                "type": "string",
                "enum": ["USER"]
              },
              "user_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "user_deleted": {
                "title": "",
                "type": "boolean",
                "required": false
              },
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "transfer_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "transfer_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "transfer_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "transfer_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "to": {
                "title": "destination address (phone number/email)",
                "type": "string",
                "required": false
              },
              "to_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "message_pack_id": {
              "title": "",
              "type": "integer"
            },
            "message_id": {
              "title": "",
              "type": "integer"
            },
            "failed": {
              "title": "",
              "type": "boolean"
            },
            "fail_reason": {
              "title": "",
              "type": "string"
            },
            "tracking_id": {
              "title": "",
              "type": "string"
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            },
            "user_id": {
              "title": "",
              "type": "integer"
            },
            "transfer_date": {
              "title": "date type (gregorian/jalali) depends on input date_type",
              "type": "string"
            },
            "source": {
              "title": "source (sender) address (phone number / email)",
              "type": "string"
            },
            "destination": {
              "title": "destination address (phone number / email)",
              "type": "string"
            },
            "body": {
              "title": "",
              "type": "string"
            },
            "consumed_credit": {
              "title": "",
              "type": "number"
            }
          }
        }
      }
    },
    {
      "name": "mc.adminSearchSentMessage",
      "description": "Messages of ISP",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "owner_type": {
                "title": "",
                "type": "string",
                "enum": ["ISP"]
              },
              "isp_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "transfer_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "transfer_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "transfer_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "transfer_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "to": {
                "title": "destination address (number/email)",
                "type": "string",
                "required": false
              },
              "to_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "message_pack_id": {
              "title": "",
              "type": "integer"
            },
            "message_id": {
              "title": "",
              "type": "integer"
            },
            "failed": {
              "title": "",
              "type": "boolean"
            },
            "fail_reason": {
              "title": "",
              "type": "string"
            },
            "tracking_id": {
              "title": "",
              "type": "string"
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            },
            "user_id": {
              "title": "",
              "type": "integer"
            },
            "transfer_date": {
              "title": "date type (gregorian/jalali) depends on input date_type",
              "type": "string"
            },
            "source": {
              "title": "",
              "type": "string"
            },
            "destination": {
              "title": "",
              "type": "string"
            },
            "body": {
              "title": "",
              "type": "string"
            },
            "consumed_credit": {
              "title": "",
              "type": "number"
            }
          }
        }
      }
    },
    {
      "name": "mc.adminSearchQueuedMessage",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "owner_type": {
                "title": "",
                "type": "string",
                "enum": ["ISP", "USER"]
              },
              "owner_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "isp_names": {
                "title": "",
                "type": "string",
                "required": false
              },
              "schedule_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "schedule_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "schedule_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "schedule_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "to": {
                "title": "destination address (number/email)",
                "type": "string",
                "required": false
              },
              "to_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "source": {
                "title": "source address (number/email)",
                "type": "string",
                "required": false
              },
              "source_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "message_pack_id": {
              "title": "",
              "type": "integer"
            },
            "message_id": {
              "title": "",
              "type": "integer"
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            },
            "owner_type": {
              "title": "",
              "type": "string",
              "enum": ["ISP", "USER"]
            },
            "owner_id": {
              "title": "",
              "type": "integer"
            },
            "scheduled_date": {
              "title": "date type (gregorian/jalali) depends on input date_type",
              "type": "string"
            },
            "try_count": {
              "title": "",
              "type": "integer"
            },
            "source": {
              "title": "",
              "type": "string"
            },
            "destination": {
              "title": "",
              "type": "string"
            },
            "body": {
              "title": "",
              "type": "string"
            },
            "consumed_credit": {
              "title": "",
              "type": "number"
            },
            "isp_send_to_all": {
              "title": "",
              "type": "integer"
            },
            "in_process": {
              "title": "",
              "type": "boolean"
            }
          }
        }
      }
    },
    {
      "name": "mc.userSearchQueuedMessage",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "conds",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {
              "message_ids": {
                "title": "",
                "type": "integer",
                "required": false
              },
              "schedule_date_from": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "schedule_date_from_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "schedule_date_to": {
                "title": "datetime or number, ",
                "type": ["string", "number"],
                "required": false
              },
              "schedule_date_to_unit": {
                "title": "",
                "type": "string",
                "enum": [
                  "jalali",
                  "gregorian",
                  "years",
                  "months",
                  "days",
                  "hours",
                  "minutes"
                ]
              },
              "body": {
                "title": "message body",
                "type": "string",
                "required": false
              },
              "body_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "to": {
                "title": "destination address (number/email)",
                "type": "string",
                "required": false
              },
              "to_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "source": {
                "title": "source address (number/email)",
                "type": "string",
                "required": false
              },
              "source_op": {
                "title": "",
                "type": "string",
                "enum": ["like", "ilike", "starts_with", "ends_with", "equals"]
              },
              "msg_types": {
                "title": "can be a list (of strings) too, for example: msg_types=['SMS', 'E-Mail']",
                "type": "string",
                "enum": [
                  "SMS",
                  "E-Mail",
                  "Message To Admin",
                  "Message To User"
                ]
              }
            }
          }
        },
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "message_pack_id": {
              "title": "",
              "type": "integer"
            },
            "message_id": {
              "title": "",
              "type": "integer"
            },
            "msg_type": {
              "title": "",
              "type": "string",
              "enum": ["SMS", "E-Mail", "Message To Admin", "Message To User"]
            },
            "owner_type": {
              "title": "",
              "type": "string",
              "enum": ["ISP", "USER"]
            },
            "owner_id": {
              "title": "",
              "type": "integer"
            },
            "scheduled_date": {
              "title": "date type (gregorian/jalali) depends on input date_type",
              "type": "string"
            },
            "try_count": {
              "title": "",
              "type": "integer"
            },
            "source": {
              "title": "",
              "type": "string"
            },
            "destination": {
              "title": "",
              "type": "string"
            },
            "body": {
              "title": "",
              "type": "string"
            },
            "consumed_credit": {
              "title": "",
              "type": "number"
            },
            "isp_send_to_all": {
              "title": "",
              "type": "integer"
            },
            "in_process": {
              "title": "",
              "type": "boolean"
            }
          }
        }
      }
    },
    {
      "name": "mc.userSearchMessagesForDialer",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "from",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "to",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "order_by",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["message_id", "msg_type", "transfer_date"]
          }
        },
        {
          "name": "desc",
          "description": "descending",
          "schema": {
            "type": "boolean"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "messages": {
              "title": "",
              "type": "array",
              "items": {
                "title": "",
                "type": "array"
              }
            }
          }
        }
      }
    },
    {
      "name": "mc.getUserLastMessageID",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [],
      "result": {
        "name": "Response (integer)",
        "summary": "Message ID of Last Message",
        "schema": {
          "title": "",
          "type": "integer"
        }
      }
    },
    {
      "name": "mc.dialerDeleteMessage",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "message_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.userDeleteMessage",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "message_ids",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "target_box",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["USER_SEND", "USER_RECEIVE", "QUEUE"]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.adminDeleteMessage",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "message_ids",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "target_box",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "USER_SEND",
              "USER_RECEIVE",
              "ISP_SEND",
              "ISP_RECEIVE",
              "QUEUE"
            ]
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.userCancelScheduledMessages",
      "description": "",
      "auth_type": ["NORMAL_USER", "VOIP_USER"],
      "params": [
        {
          "name": "message_ids",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.adminCancelScheduledMessages",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "message_ids",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.updateAdminRemoteRequestAttrs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "remote_report_status",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "remote_report_command",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "allowed_requesters",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "attrs",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.updateUserRemoteRequestAttrs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "remote_report_status",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "remote_report_command",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "allowed_requesters",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "attrs",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "mc.getRemoteRequestAttrs",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["SEE MESSAGE CENTER REPORTS"],
      "params": [
        {
          "name": "type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": ["ADMIN", "USER"]
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object"
        }
      }
    }
  ]
}