Outgoing numbers

Outgoing numbers are used to choose the displayed caller ID for phone campaigns.

Fields

class OutgoingNumber

id: integer

The outgoing number’s unique ID.

name: string

The outgoing number’s name.

number: string

The outgoing number’s phone number.

team: string

The outgoing number’s team.

API

GET /j/outgoing_numbers

Retrieves the list of outgoing numbers.

Example request:

GET /j/outgoing_numbers HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
      "id": 1,
      "name": "First number",
      "number": "+33122334455",
      "team": 1
   },
   {
      "id": 2,
      "name": "Second number",
      "number": "+33233445566",
      "team": 1
   }
]

Request Headers:

• Authorization – OAuth token to authenticate

Query Parameters:

• team (integer) – An optional team ID.

Response JSON Array of Objects:

• id (integer) – The outgoing number’s unique ID.

• name (string) – The outgoing number’s name.

• number (string) – The outgoing number’s phone number.

• team (string) – The outgoing number’s team.

Status Codes:

• 200 OK – no error

• 400 Bad Request – for instance a required field is missing

• 403 Forbidden – you tried to access a forbidden resource, check you provided a valid OAuth token