GET
/
v1
/
sms
/
routing
/
sms-tests
/
schedules
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/sms/routing/sms-tests/schedules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "sms_route_id": "<string>",
      "meta": {
        "sim_ids": [
          "<string>"
        ],
        "days_of_week": [
          "<string>"
        ],
        "time_slots": [
          "<string>"
        ],
        "sid": "<string>",
        "message": "<string>",
        "require_sms": true
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "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>"
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

sms_route_id
string<uuid> | null

Response

Array of SmsTestScheduleResource

data
SmsTestScheduleResource · object[]
required