Comms API ReferenceSenders

Search Senders

This operation allows searching on senders on specific filters.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

This endpoint expects an object.
addressstringRequired

The Sender’s communication address within a channel, such as a phone number, email address, or device token.

channelenumRequired

The medium which a unit of communication is transmitted through. These are differentiated by a mix of transmission protocol, network controller/owner, endpoint and address model, as well as the model for content of the atomic unit of communication itself.

statusenumOptional

The status of a Sender. If a Sender is activated, it is available to send and receive communications. If a Sender is deactivated, it is not available to send or receive communications.

Allowed values:
pageTokenstringOptional
A page token that represents the start sender of a page
pageSizeintegerOptional1-1000Defaults to 50
Total number of items returned in a single page, the minimum is 1 and maximum is 1000. Default is 50.

Response

OK
senderslist of objects
paginationobject
Metadata for paginated results. This object contains two tokens to navigate through paginated results. - Use `next` to retrieve the 'next' page in the result list. - Use `self` to retrieve the same page of the result list again. - Supply the token in the `pageToken` query param.

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error