Messages

List Messages for extension

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

get/v4/accounts/{voip_id}/extensions/{extension_id}/messages

Request

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

Path parameters

voip_idinteger required
extension_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[message_id]string

Message ID filter

filters[direction]string

Message direction filter: in or out

filters[to]string

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

filters[from]string

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

filters[extension_id]string

Account extension filter

filters[deleted]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;

filters[read]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;

filters[conversation_id]string

Conversation ID filter

filters[updated_at]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".

filters[created_at]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".

filters[archived_at]string

Archived At filter

filters[created_after]string

Created after filter

filters[created_before]string

Created before filter

filters[updated_after]string

Updated after filter

filters[updated_before]string

Updated before filter

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.