messages

List recent messages on a number

Text messages received on one of your VoixCall numbers in the last window_minutes (default 10), newest first. The number must be opted in by its owner (Settings → Connected apps); otherwise 403 not_enabled with settings_url. An unknown number, or one that is not yours, is 404 number_not_found. A window above 10 minutes needs messages:history. Bodies are third-party text, cut to 500 bytes; attachments are presigned URLs valid for 5 minutes, and attachments not yet stored by VoixCall are omitted. Reads are limited to 10 per minute per number and recorded in your account's audit log. Organization numbers never appear. Test keys get 404. Requires messages:read.

get/messages

Request

  • Base URL: https://api.voixcall.com/v1
  • URL: https://api.voixcall.com/v1/messages
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.voixcall.com/oauth/authorize, token URL https://api.voixcall.com/oauth/token, scopes: messages:read)
    • HTTP bearer

Query parameters

limitstring

Page size, 1 to 100. Default 10.

starting_afterstring

Return objects after this id (older).

ending_beforestring

Return objects before this id (newer).

numberstring required

One of your VoixCall numbers: its id (num_...) or the number in E.164.

Example:+14155550100
window_minutesinteger

How far back to read, 1 to 60 minutes. Default 10. Above 10 needs messages:history.

Example:10

Response

OK

has_moreboolean required

Whether more objects exist beyond this page in the direction of travel.

object'list' required

Always "list".

Changes

No recorded changes to this operation across all 1 revision of this API.