SMS

List SMS

Get a list of SMS messages for an account.

get/v4/accounts/{voip_id}/sms

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/sms
  • Auth: HTTP bearer

Path parameters

voip_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

filters[id]string

ID filter

filters[is_new]string

1 when SMS is new; 0 when SMS has been read.

filters[from]string

Caller ID filter, the E.164 phone number to send the SMS FROM. Note: you must encode the + as %2B, and the direction filter is required.

filters[to]string

Callee ID filter, the E.164 phone number to send the SMS TO. Note you must encode the + as %2B, and the direction filter is required.

filters[direction]string

Direction filter, in or out

filters[created_at]string

Date string representing the UTC time that sms was created. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[updated_at]string

Date string representing the UTC time that sms was updated. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[extension]string

Extension id where SMS is stored

filters[deleted]string

only=deleted SMS; ignore=existing SMS; with=both deleted and existing SMS

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.