API Reference

List Messages for extension

get
https://api.phone.com/v4/accounts//extensions//messages

This service is used to get messages for given filters for extension.

Path Params
integer
required
≥ 1
integer
required
≥ 1
Query Params
integer
≥ 0
Defaults to 0

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

integer
1 to 500
Defaults to 25

The number of items to return

string
enum

Sort response

Allowed:
string

Message ID filter

string

Message direction filter: in or out

string

Callee ID filter, the E.164 phone number to which Message was sent. Note you must encode the + as %2B

string

Caller ID filter, the E.164 phone number from which Message was sent. Note: you must encode the + as %2B

string

Account extension filter

string

Deleted filter: only=Gives only the not deleted messages; with=Gives the messages no matter if they are deleted; ignore=Gives only the soft deleted messages;

string

Read filter: only=Gives only the not deleted messages; with=Gives the messages no matter if they are deleted; ignore=Gives only the soft deleted messages;

string

Conversation ID filter

string

Updated At filter. 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".

string

Created At filter. 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".

string

Archived At filter

string

Created after filter

string

Created before filter

string

Updated after filter

string

Updated before filter

string
enum
Defaults to full

Defines mode of the data output (brief or full)

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago