Phone Numbers

List the phone numbers specific teammates may send from

GET
/api/phone-numbers/for-users

Every org phone number any of the listed users may send from (link, group link or send grant), one row per number. userIds on a row names the listed users who may send from it and via is the best way any of them reaches it; linkedUserId stays the number's inbound owner. Scoped to the caller's organization, at most 200 users per request. The org default line is never a row; orgDefaultAvailable reports it. Same channel narrowing as GET /api/phone-numbers. Any authenticated user (the campaign builder lists assignees' lines).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

userIds*string

Comma-separated user ids. Invalid ids are ignored.

channel?string

Only numbers usable to start a conversation on this channel: the organization's active provider for it, the capability, and active status. Omit for every number.

Value in

  • "sms"
  • "voice"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/phone-numbers/for-users?userIds=string"
{  "phoneNumbers": [    {      "phoneNumberId": "string",      "provider": "string",      "phoneNumber": "string",      "numberType": "longcode",      "capabilities": [        "sms"      ],      "status": "active",      "label": "string",      "routing": {},      "linkedUserId": "string",      "userIds": [        "string"      ],      "via": "link"    }  ],  "orgDefaultAvailable": true}