INinteractly
Phone Numbers

List Numbers

Get list of Numbers purchased

get/assistants/v1/numbers

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/assistants/v1/numbers
  • Auth
    HTTP bearer

Query parameters

labelstring

Filter numbers by label

Response

Successfully retrieved the list of numbers.

_idstring objectId required

Unique identifier of the number

teamIdstring objectId required

This is unique identifier of the team.

numberstring required

Phone number associated with the team

assistantIdstring

ID of the associated assistant (if any)

inboundEnabledboolean

If true, inbound call is enabled. If false, inbound call is disabled.

outboundEnabledboolean

If true, outbound call is enabled. If false, outbound call is disabled.

labelstring

Label for the number

Example response

[
  {
    "_id": "a12f9c88-c155-461f-9771-4d240cdc9a04",
    "teamId": "1f7b1b1b1b1b1b1b1b1b1b1b",
    "number": "+1234567890",
    "provider": {
      "name": "twilio"
    },
    "assistantId": "a12f9c88-c155-461f-9771-4d240cdc9a04",
    "inboundEnabled": true,
    "outboundEnabled": true,
    "label": "friendly-name-1"
  }
]

Changes

No recorded changes to this operation across all 13 revisions of this API.