Query SMS Service Provider List

Retrieve the service providers for SMS messaging channel.

Request URL

GET {base_url}/{api_path}/message_channel/sms_itsp_list?access_token={access_token}

Request parameters

No request parameters. Send the request URL directly to get SMS service providers.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of SMS service providers.
data Array <Channel_Service_Provider> The list of SMS service providers.
Channel_Service_Provider
Parameter Type Description
channel Integer The name of the service provider.

Example

Request example

GET /openapi/v1.0/message_channel/message_channel/sms_itsp_list?access_token=mihPhXcEH1xnHvMhVv3Sfm23QITN3B4c HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 24,
    "list": [
        {
            "channel": "general"
        },
        {
            "channel": "alhambra"
        },
        {
            "channel": "apidaze"
        },
        {
            "channel": "aspsms"
        },
        {
            "channel": "athena"
        },
        {
            "channel": "bandwidth"
        },
        {
            "channel": "channel01"
        },
        {
            "channel": "channel02"
        },
        {
            "channel": "channel03"
        },
        {
            "channel": "channel07"
        },
        {
            "channel": "clearfly"
        },
        {
            "channel": "ixica"
        },
        {
            "channel": "iztcloudvoice"
        },
        {
            "channel": "mock"
        },
        {
            "channel": "netplanet"
        },
        {
            "channel": "siptrunk"
        },
        {
            "channel": "skyetel"
        },
        {
            "channel": "telnyx"
        },
        {
            "channel": "flowroute"
        },
        {
            "channel": "twilio"
        },
        {
            "channel": "vetta"
        },
        {
            "channel": "voipms"
        },
        {
            "channel": "voicemeup"
        },
        {
            "channel": "voxtelesys"
        }
    ]
}