Get v1smsroutingsms tests - CommVoice Documentation

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": [
        "<unknown>"
      ],
      "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>",
        "is_connected": true,
        "connection_id": "<string>",
        "rates_total": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "links": {
          "delete": "<string>"
        },
        "queue_info": [
          "<unknown>"
        ],
        "company": {
          "id": "<string>",
          "team_id": "<string>",
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "is_active": true,
          "overdraft_enabled": true,
          "overdraft_limit": 123,
          "provider_balance": 123,
          "provider_balance_updated_at": "<string>",
          "balance_checker": "<string>",
          "endpoints_count": "<string>",
          "sms_routes_count": "<string>",
          "balance_email": "<string>",
          "links": [
            "<string>"
          ],
          "client_balance": "<string>",
          "vendor_balance": "<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
          }
        },
        "connection": "<string>",
        "client_balance": 123,
        "vendor_balance": 123
      },
      "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>"
      }
    }
  ]
}

GET

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": [
        "<unknown>"
      ],
      "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>",
        "is_connected": true,
        "connection_id": "<string>",
        "rates_total": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "links": {
          "delete": "<string>"
        },
        "queue_info": [
          "<unknown>"
        ],
        "company": {
          "id": "<string>",
          "team_id": "<string>",
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "is_active": true,
          "overdraft_enabled": true,
          "overdraft_limit": 123,
          "provider_balance": 123,
          "provider_balance_updated_at": "<string>",
          "balance_checker": "<string>",
          "endpoints_count": "<string>",
          "sms_routes_count": "<string>",
          "balance_email": "<string>",
          "links": [
            "<string>"
          ],
          "client_balance": "<string>",
          "vendor_balance": "<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
          }
        },
        "connection": "<string>",
        "client_balance": 123,
        "vendor_balance": 123
      },
      "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

string

search_ids

string<uuid>[]

Response

Array of SmsTestResource

data

SmsTestResource · object[]

required

Show child attributes

data.id

string

required

data.sms_route_id

string

required

data.test_schedule_id

string | null

required

data.foreign_id

string | null

required

data.sid

string | null

required

data.destphone

integer | null

required

data.country_id

integer | null

required

data.code

string | null

required

data.mcc

integer | null

required

data.mnc

integer | null

required

data.network_name

string | null

required

data.status

string

required

data.raw_response

any[] | null

required

data.created_at

string<date-time> | null

required

data.updated_at

string<date-time> | null

required

data.sms_id

string | null

required

data.sms_route

SmsRoutingRouteResource · object

Show child attributes

data.sms_route.id

string

required

data.sms_route.name

string

required

data.sms_route.company_id

string

required

data.sms_route.is_connected

boolean | null

required

data.sms_route.connection_id

string | null

required

data.sms_route.rates_total

integer

required

'rates' => SmsRoutingRateResource::collection($this->whenLoaded('smsRouteRates')),

data.sms_route.created_at

string<date-time> | null

required

data.sms_route.links

object

required

Show child attributes

data.sms_route.links.delete

string

required

"edit" => action([SmsRoutingRoutesController::class, 'edit'], $this), "update" => action([SmsRoutingRoutesController::class, 'update'], $this),

data.sms_route.queue_info

any[] | null

required

data.sms_route.company

CompanyResource · object

Show child attributes

data.sms_route.company.id

string

required

data.sms_route.company.team_id

string

required

data.sms_route.company.name

string

required

data.sms_route.company.created_at

string

required

data.sms_route.company.updated_at

string

required

data.sms_route.company.is_active

boolean

required

data.sms_route.company.overdraft_enabled

boolean

required

data.sms_route.company.overdraft_limit

integer

required

data.sms_route.company.provider_balance

number | null

required

data.sms_route.company.provider_balance_updated_at

string

required

data.sms_route.company.balance_checker

string

required

data.sms_route.company.endpoints_count

string

required

data.sms_route.company.sms_routes_count

string

required

data.sms_route.company.balance_email

string

required

data.sms_route.company.links

string[]

required

Required array length: 0 element

data.sms_route.company.client_balance

string

data.sms_route.company.vendor_balance

string

data.sms_route.company.balance_checker_data

BalanceCheckerData · object

balance_checker_data

Show child attributes

data.sms_route.company.balance_checker_data.balance_checker

enum<string>

required

Available options:

api,

email,

none

data.sms_route.company.balance_checker_data.balance_regex

string | null

required

data.sms_route.company.balance_checker_data.api_auth_type

enum<string> | null

required

Available options:

none,

basic,

bearer,

custom

data.sms_route.company.balance_checker_data.api_auth_data

string[] | null

required

data.sms_route.company.balance_checker_data.balance_endpoint_url

string<uri> | null

required

data.sms_route.company.balance_checker_data.balance_endpoint_method

enum<string> | null

required

Available options:

GET,

POST

data.sms_route.company.balance_checker_data.balance_json_path

string | null

required

data.sms_route.company.balance_checker_data.notification_if_no_data_x_days

integer | null

required

Required range: x >= 1

data.sms_route.connection

string

data.sms_route.client_balance

number

data.sms_route.vendor_balance

number

data.sms

DataGridApiSendLogResource · object

Show child attributes

data.sms.sms_id

string

required

data.sms.endpoint_id

string

required

data.sms.sms_route_id

string

required

data.sms.sms_routing_plan_id

string

required

data.sms.client_company_id

string

required

data.sms.vendor_company_id

string

required

data.sms.foreign_id

string

required

data.sms.country_id

string

required

data.sms.source_addr

string

required

'registered_delivery' => $this->resource['registered_delivery'], 'esm_class' => $this->resource['esm_class'], 'data_coding' => $this->resource['data_coding'], 'sm_length' => $this->resource['sm_length'], 'user_message_reference' => $this->resource['user_message_reference'], 'sar_msg_ref_num' => $this->resource['sar_msg_ref_num'], 'sar_total_segments' => $this->resource['sar_total_segments'], 'sar_segment_seqnum' => $this->resource['sar_segment_seqnum'], 'payload_type' => $this->resource['payload_type'], 'source_addr_ton' => $this->resource['source_addr_ton'], 'source_addr_npi' => $this->resource['source_addr_npi'], 'dest_addr_ton' => $this->resource['dest_addr_ton'], 'dest_addr_npi' => $this->resource['dest_addr_npi'], 'service_type' => $this->resource['service_type'],

data.sms.destination_addr

string

required

data.sms.message_payload

string

required

'schedule_delivery_time' => $this->resource['schedule_delivery_time'], 'validity_period' => $this->resource['validity_period'],

data.sms.dlr_status

string

required

'pdu' => $this->resource['pdu'], 'error' => $this->resource['error'], 'error_code' => $this->resource['error_code'],

data.sms.network_id

string

required

'dlr_received' => $this->resource['dlr_received'], 'dlr_sent' => $this->resource['dlr_sent'],

data.sms.network_brand

string

required

data.sms.cost

string

required

data.sms.profit

string

required

data.sms.is_sent

string

required

data.sms.is_clicked

string

required

data.sms.is_lead

string

required

data.sms.is_sale

string

required

data.sms.is_delivered

string

required

data.sms.created_at

string

required

Get v1webhookssmstests Post v1smsroutingsms tests

⌘I

Endpoints

Authorizations

Query Parameters

Response