API REFERENCE

Sender IDs API

The SimplyRCS sender ids API has 32 public endpoints. Every endpoint below is documented with its parameters, responses and an example request. The reference is public and needs no account; a scoped API key is required only to make live calls.

Sender IDs, channels, protocols, and RCS sender resources.

Base URL https://api.simplyrcs.com · All 195 endpoints · Pricing

Endpoints in this section

GET /v1/sender-ids
POST /v1/sender-ids
GET /v1/sender-ids/{id}
PATCH /v1/sender-ids/{id}
DELETE /v1/sender-ids/{id}
POST /v1/sender-ids/{id}/activate
POST /v1/sender-ids/{id}/suspend
POST /v1/sender-ids/{id}/reactivate
POST /v1/sender-ids/numbers/search
POST /v1/sender-ids/numbers/purchase
POST /v1/sender-ids/numbers/import
DELETE /v1/sender-ids/numbers/{id}/release
GET /v1/sender-ids/numbers
GET /v1/sender-ids/{id}/protocols
POST /v1/sender-ids/{id}/protocols
PATCH /v1/sender-ids/{id}/protocols/{type}
DELETE /v1/sender-ids/{id}/protocols/{type}
GET /v1/channels
POST /v1/channels
GET /v1/channels/{id}
PUT /v1/channels/{id}
DELETE /v1/channels/{id}
POST /v1/channels/{id}/test
GET /v1/channels/{channelId}/rcs/senders
POST /v1/channels/{channelId}/rcs/senders
GET /v1/channels/{channelId}/rcs/senders/{senderName}
POST /v1/channels/{channelId}/rcs/senders/{senderName}/test-devices
GET /v1/channels/{channelId}/rcs/senders/{senderName}/test-devices
DELETE /v1/channels/{channelId}/rcs/senders/{senderName}/test-devices/{phone}
GET /v1/sender-ids/{id}/voice-forwarding
PUT /v1/sender-ids/{id}/voice-forwarding
DELETE /v1/sender-ids/{id}/voice-forwarding

GET/v1/sender-ids

List sender IDs

GET https://api.simplyrcs.com/v1/sender-ids · requires an API key

Query parameters

Name	Type	Required
`type`	`SenderIdType`	No
`status`	`SenderIdStatus`	No
`provider`	`SenderIdProvider`	No

Responses

Status	Returns	Description
`200`	`ListSenderIdsResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/sender-ids \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/sender-ids

Create a sender ID

POST https://api.simplyrcs.com/v1/sender-ids · requires an API key

Request body

CreateSenderIdBody · optional

Responses

Status	Returns	Description
`201`	`SenderIdResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/sender-ids/{id}

Get a sender ID

GET https://api.simplyrcs.com/v1/sender-ids/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`SenderIdResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/sender-ids/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/v1/sender-ids/{id}

Update a sender ID

PATCH https://api.simplyrcs.com/v1/sender-ids/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

UpdateSenderIdBody · optional

Responses

Status	Returns	Description
`200`	`SenderIdResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X PATCH https://api.simplyrcs.com/v1/sender-ids/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/sender-ids/{id}

Delete a sender ID

DELETE https://api.simplyrcs.com/v1/sender-ids/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`object`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/sender-ids/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/sender-ids/{id}/activate

Activate a sender ID

POST https://api.simplyrcs.com/v1/sender-ids/{id}/activate · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`SenderIdResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/{id}/activate \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/sender-ids/{id}/suspend

Suspend a sender ID

POST https://api.simplyrcs.com/v1/sender-ids/{id}/suspend · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`SenderIdResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/{id}/suspend \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/sender-ids/{id}/reactivate

Reactivate a sender ID

POST https://api.simplyrcs.com/v1/sender-ids/{id}/reactivate · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`SenderIdResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/{id}/reactivate \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/sender-ids/numbers/search

Search sender ID numbers

POST https://api.simplyrcs.com/v1/sender-ids/numbers/search · requires an API key

Request body

SenderIdNumberSearchBody · optional

Responses

Status	Returns	Description
`200`	`SenderIdNumberSearchResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/numbers/search \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/sender-ids/numbers/purchase

Purchase a sender ID number

POST https://api.simplyrcs.com/v1/sender-ids/numbers/purchase · requires an API key

Request body

SenderIdPurchaseNumberBody · optional

Responses

Status	Returns	Description
`201`	`PurchaseSenderIdNumberResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/numbers/purchase \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

POST/v1/sender-ids/numbers/import

Import an owned sender ID number

POST https://api.simplyrcs.com/v1/sender-ids/numbers/import · requires an API key

Request body

SenderIdImportNumberBody · optional

Responses

Status	Returns	Description
`201`	`ImportSenderIdNumberResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/numbers/import \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/sender-ids/numbers/{id}/release

Release a sender ID number

DELETE https://api.simplyrcs.com/v1/sender-ids/numbers/{id}/release · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`object`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/sender-ids/numbers/{id}/release \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/sender-ids/numbers

List purchased sender ID numbers

GET https://api.simplyrcs.com/v1/sender-ids/numbers · requires an API key

Query parameters

Name	Type	Required
`page`	`integer`	No
`limit`	`integer`	No
`provider`	`"INFOBIP" \| "SIGNALMASH"`	No

Responses

Status	Returns	Description
`200`	`ListSenderIdNumbersResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/sender-ids/numbers \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/sender-ids/{id}/protocols

List sender protocols

GET https://api.simplyrcs.com/v1/sender-ids/{id}/protocols · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`ListSenderProtocolsResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/sender-ids/{id}/protocols \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/sender-ids/{id}/protocols

Enable a sender protocol

POST https://api.simplyrcs.com/v1/sender-ids/{id}/protocols · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

EnableSenderProtocolBody · optional

Responses

Status	Returns	Description
`200`	`SenderProtocolResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/sender-ids/{id}/protocols \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

PATCH/v1/sender-ids/{id}/protocols/{type}

Update sender protocol config

PATCH https://api.simplyrcs.com/v1/sender-ids/{id}/protocols/{type} · requires an API key

Path parameters

Name	Type	Description
`id` required	`string`
`type` required	`SenderProtocolType`

Request body

UpdateSenderProtocolBody · optional

Responses

Status	Returns	Description
`200`	`SenderProtocolResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X PATCH https://api.simplyrcs.com/v1/sender-ids/{id}/protocols/{type} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/sender-ids/{id}/protocols/{type}

Disable a sender protocol

DELETE https://api.simplyrcs.com/v1/sender-ids/{id}/protocols/{type} · requires an API key

Path parameters

Name	Type	Description
`id` required	`string`
`type` required	`SenderProtocolType`

Responses

Status	Returns	Description
`200`	`SenderProtocolResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/sender-ids/{id}/protocols/{type} \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/channels

List channels

Deprecated in favor of /v1/sender-ids (Sunset: 2026-09-01).

GET https://api.simplyrcs.com/v1/channels · requires an API key

Responses

Status	Returns	Description
`200`	`ListChannelsResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/channels \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/channels

Create a channel

Deprecated in favor of /v1/sender-ids (Sunset: 2026-09-01).

POST https://api.simplyrcs.com/v1/channels · requires an API key

Request body

CreateChannelBody · optional

Responses

Status	Returns	Description
`201`	`ChannelWithHealthResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/channels \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/channels/{id}

Get a channel

Deprecated in favor of /v1/sender-ids (Sunset: 2026-09-01).

GET https://api.simplyrcs.com/v1/channels/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`ChannelResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/channels/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/v1/channels/{id}

Update a channel

Deprecated in favor of /v1/sender-ids (Sunset: 2026-09-01).

PUT https://api.simplyrcs.com/v1/channels/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

UpdateChannelBody · optional

Responses

Status	Returns	Description
`200`	`ChannelWithHealthResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X PUT https://api.simplyrcs.com/v1/channels/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/channels/{id}

Delete a channel

Deprecated in favor of /v1/sender-ids (Sunset: 2026-09-01).

DELETE https://api.simplyrcs.com/v1/channels/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`DeleteChannelResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/channels/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/channels/{id}/test

Test a channel

Deprecated in favor of /v1/sender-ids (Sunset: 2026-09-01).

POST https://api.simplyrcs.com/v1/channels/{id}/test · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`ChannelHealth`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/channels/{id}/test \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/channels/{channelId}/rcs/senders

List RCS senders

GET https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders · requires an API key

Path parameters

Name	Type	Description
`channelId` required	`string`

Responses

Status	Returns	Description
`200`	`ListRcsSendersResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/channels/{channelId}/rcs/senders

Create an RCS sender

POST https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders · requires an API key

Path parameters

Name	Type	Description
`channelId` required	`string`

Request body

CreateRcsSenderBody · optional

Responses

Status	Returns	Description
`201`	`RcsSenderResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/channels/{channelId}/rcs/senders/{senderName}

Get an RCS sender

GET https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName} · requires an API key

Path parameters

Name	Type	Description
`channelId` required	`string`
`senderName` required	`string`

Responses

Status	Returns	Description
`200`	`object`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName} \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices

Add an RCS sender test device

POST https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices · requires an API key

Path parameters

Name	Type	Description
`channelId` required	`string`
`senderName` required	`string`

Request body

AddRcsTestDeviceBody · optional

Responses

Status	Returns	Description
`201`	`RcsTestDeviceResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices

List RCS sender test devices

GET https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices · requires an API key

Path parameters

Name	Type	Description
`channelId` required	`string`
`senderName` required	`string`

Responses

Status	Returns	Description
`200`	`ListRcsTestDevicesResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices \
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices/{phone}

Delete an RCS sender test device

DELETE https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices/{phone} · requires an API key

Path parameters

Name	Type	Description
`channelId` required	`string`
`senderName` required	`string`
`phone` required	`string`

Responses

Status	Returns	Description
`200`	`SuccessResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/channels/{channelId}/rcs/senders/{senderName}/test-devices/{phone} \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/sender-ids/{id}/voice-forwarding

Get voice forwarding configuration

Returns the inbound-voice call-forwarding configuration for a voice-capable sender ID. data is null when forwarding has never been configured.

GET https://api.simplyrcs.com/v1/sender-ids/{id}/voice-forwarding · requires an API key

Path parameters

Name	Type	Description
`id` required	`string`	Sender ID id

Responses

Status	Returns	Description
`200`	`VoiceForwardingResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/sender-ids/{id}/voice-forwarding \
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/v1/sender-ids/{id}/voice-forwarding

Set voice forwarding destination

Enables inbound-call forwarding to the given destination number (US/CA destinations only) and syncs the change to the voice provider.

PUT https://api.simplyrcs.com/v1/sender-ids/{id}/voice-forwarding · requires an API key

Path parameters

Name	Type	Description
`id` required	`string`	Sender ID id

Request body

VoiceForwardingSetRequest · optional

Responses

Status	Returns	Description
`200`	`VoiceForwardingResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X PUT https://api.simplyrcs.com/v1/sender-ids/{id}/voice-forwarding \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/sender-ids/{id}/voice-forwarding

Disable voice forwarding

Disables inbound-call forwarding for the sender ID and syncs the change to the voice provider. Returns the updated configuration.

DELETE https://api.simplyrcs.com/v1/sender-ids/{id}/voice-forwarding · requires an API key

Path parameters

Name	Type	Description
`id` required	`string`	Sender ID id

Responses

Status	Returns	Description
`200`	`VoiceForwardingResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/sender-ids/{id}/voice-forwarding \
  -H 'Authorization: Bearer YOUR_API_KEY'

Other parts of the API

Get a free sender ID test Read the RCS API guide