SMS providers API

SMS providers

Connect SMS providers and manage senders, registrations, routes by country, rules and test numbers.

Operations

GET

/api/v1/workspaces/{workspace}/sms/catalog

GET

/api/v1/workspaces/{workspace}/sms/events

GET

/api/v1/workspaces/{workspace}/sms/message-options

GET

/api/v1/workspaces/{workspace}/sms/messages/{id}

GET

/api/v1/workspaces/{workspace}/sms/overview

POST

/api/v1/workspaces/{workspace}/sms/providers

DELETE

/api/v1/workspaces/{workspace}/sms/providers/{providerId}

POST

/api/v1/workspaces/{workspace}/sms/providers/{providerId}/check

PUT

/api/v1/workspaces/{workspace}/sms/providers/{providerId}/credentials

GET

/api/v1/workspaces/{workspace}/sms/providers/{providerId}/numbers

POST

/api/v1/workspaces/{workspace}/sms/providers/{providerId}/senders

POST

/api/v1/workspaces/{workspace}/sms/providers/{providerId}/test

POST

/api/v1/workspaces/{workspace}/sms/providers/{providerId}/webhooks

POST

/api/v1/workspaces/{workspace}/sms/route-test

PUT

/api/v1/workspaces/{workspace}/sms/routes

GET

/api/v1/workspaces/{workspace}/sms/rules

PUT

/api/v1/workspaces/{workspace}/sms/rules

POST

/api/v1/workspaces/{workspace}/sms/senders

DELETE

/api/v1/workspaces/{workspace}/sms/senders/{senderId}

PATCH

/api/v1/workspaces/{workspace}/sms/senders/{senderId}

GET

/api/v1/workspaces/{workspace}/sms/senders/{senderId}/registration

PUT

/api/v1/workspaces/{workspace}/sms/senders/{senderId}/registration

POST

/api/v1/workspaces/{workspace}/sms/senders/{senderId}/registration/check-pages

POST

/api/v1/workspaces/{workspace}/sms/senders/{senderId}/registration/read

POST

/api/v1/workspaces/{workspace}/sms/setups/{id}/finish

PUT

/api/v1/workspaces/{workspace}/sms/short-domain

POST

/api/v1/workspaces/{workspace}/sms/short-domain/check

GET

/api/v1/workspaces/{workspace}/sms/test-numbers

POST

/api/v1/workspaces/{workspace}/sms/test-numbers

DELETE

/api/v1/workspaces/{workspace}/sms/test-numbers/{id}