GET
/
v1
/
sms
/
routing
/
sms-tests
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/sms/routing/sms-tests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "sms_route_id": "<string>",
      "test_schedule_id": "<string>",
      "foreign_id": "<string>",
      "sid": "<string>",
      "destphone": 123,
      "country_id": 123,
      "code": "<string>",
      "mcc": 123,
      "mnc": 123,
      "network_name": "<string>",
      "status": "<string>",
      "raw_response": [
        "<any>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "sms_id": "<string>",
      "sms_route": {
        "id": "<string>",
        "name": "<string>",
        "company_id": "<string>",
        "company": {
          "id": "<string>",
          "team_id": "<string>",
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "is_active": true,
          "overdraft_enabled": true,
          "overdraft_limit": 123,
          "client_balance": "<string>",
          "vendor_balance": "<string>",
          "provider_balance": 123,
          "provider_balance_updated_at": "<string>",
          "balance_checker": "<string>",
          "endpoints_count": "<string>",
          "sms_routes_count": "<string>",
          "balance_checker_data": {
            "balance_checker": "api",
            "balance_regex": "<string>",
            "api_auth_type": "none",
            "api_auth_data": [
              "<string>"
            ],
            "balance_endpoint_url": "<string>",
            "balance_endpoint_method": "GET",
            "balance_json_path": "<string>",
            "notification_if_no_data_x_days": 2
          },
          "balance_email": "<string>",
          "links": [
            "<string>"
          ]
        },
        "connection": "<string>",
        "is_connected": true,
        "connection_id": "<string>",
        "rates_total": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "links": {
          "delete": "<string>"
        },
        "client_balance": 123,
        "vendor_balance": 123,
        "queue_info": [
          "<any>"
        ]
      },
      "sms": {
        "sms_id": "<string>",
        "endpoint_id": "<string>",
        "sms_route_id": "<string>",
        "sms_routing_plan_id": "<string>",
        "client_company_id": "<string>",
        "vendor_company_id": "<string>",
        "foreign_id": "<string>",
        "country_id": "<string>",
        "source_addr": "<string>",
        "destination_addr": "<string>",
        "message_payload": "<string>",
        "dlr_status": "<string>",
        "network_id": "<string>",
        "network_brand": "<string>",
        "cost": "<string>",
        "profit": "<string>",
        "is_sent": "<string>",
        "is_clicked": "<string>",
        "is_lead": "<string>",
        "is_sale": "<string>",
        "is_delivered": "<string>",
        "created_at": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer | null
per_page
integer | null
search_ids
string<uuid>[]

Response

Array of SmsTestResource

data
SmsTestResource · object[]
required