GET - User Alternate Numbers

Fetches a list of a user/ service such as Auto Attendant, Hunt Group, or Call Centres alternate numebrs.

Parameters

  • user_id (str): Target user/ service_user_id

Returns

  • Dict: List of all alternate numbers assigned to the user/ service.

How To Use:

my_api.alternate_numbers.get_user_alternate_numbers(
    "[email protected]"
)

Example Data Returned (Formatted)

{
  "userId": "[email protected]",
  "distinctiveRing": false,
  "alternateEntries": [
    {
      "phoneNumber": "5131111112",
      "extension": "1112",
      "ringPattern": "Short-Short-Long",
      "alternateEntryId": 1
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 2
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 3
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 4
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 5
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 6
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 7
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 8
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 9
    },
    {
      "phoneNumber": null,
      "extension": null,
      "ringPattern": null,
      "alternateEntryId": 10
    }
  ]
}

Last updated

Was this helpful?