API Reference
SupportLogin
  1. Reference
  2. SMS

Search SMS

get
https://api.callr.com/v2.0/sms

Search for your SMS messages.

Query Params
string
enum
required

The direction. Inbound is a call or an SMS received by the Callr platform. Outbound is a call or an SMS initiated by the Callr platform.

Allowed:
length between 0 and 11
^[ a-zA-Z0-9_-]*$

SMS sender

string
^\+[1-9][0-9]{5,32}$

SMS to

string
length ≤ 64

SMS text body contains

string
enum

SMS traffic type

Allowed:
string
enum

The status of the SMS.

created = The SMS has been created.
error = The SMS has an error.
expired = The SMS has expired.
failed = The SMS has failed.
pending = The SMS is waiting to be sent on our side.
delivered = The SMS has been delivered to the recipient.
remote-queued = The SMS is queued on the remote side.
sent = The SMS has been sent.

date-time
required

RFC 3339, section 5.6

date-time
required

RFC 3339, section 5.6

string
enum
Defaults to created

Sort by one field

Allowed:
string
enum
Defaults to desc

Sort order (ascending or descending)

Allowed:
integer
≥ 0
Defaults to 0

Search offset index (zero-based)

integer
1 to 100
Defaults to 10

Number of items to return

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?