Features: Paging Group - Get Details for a Paging Group

Get Details for a Paging Group

Retrieve Paging Group details.

Group Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.

Retrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/locations/{locationId}/paging/{pagingId}

URI Parameters

locationId

stringrequired

Retrieve settings for a paging group in this location.

pagingId

stringrequired

Retrieve settings for the paging group with this identifier.

Query Parameters

orgId

string

Retrieve paging group settings from this organization.

Response Properties

string

A unique identifier for the paging group.

enabled

boolean

Whether or not the paging group is enabled.

name

string

Unique name for the paging group. Minimum length is 1. Maximum length is 30.

phoneNumber

string

Paging group phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.

extension

string

Paging group extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.

tollFreeNumber

boolean

Flag to indicate toll free number.

language

string

Paging language. Minimum length is 1. Maximum length is 40.

languageCode

string

Language code.

firstName

string

First name that displays when a group page is performed. Minimum length is 1. Maximum length is 64.

lastName

string

Last name that displays when a group page is performed. Minimum length is 1. Maximum length is 64.

originatorCallerIdEnabled

boolean

Determines what is shown on target users caller ID when a group page is performed. If true shows page originator ID.

originators

array[GetPagingGroupAgentObject]

An array of people, workspaces and virtual lines ID's who may originate pages to this paging group.

string

Agents ID.

firstName

string

Agent's first name. Minimum length is 1. Maximum length is 64.

lastName

string

Agent's last name. Minimum length is 1. Maximum length is 64.

type

enum

Type of the person, workspace or virtual line.

PEOPLE

string

Indicates that this object is a person.

PLACE

string

Indicates that this object is a workspace, formerly known as a place.

VIRTUAL_LINE

string

Indicates that this object is a virtual line.

phoneNumber

string

Agent's phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.

extension

string

Agent's extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.

routingPrefix

string

Routing prefix of location.

esn

string

Routing prefix + extension of a person or workspace.

targets

array[GetPagingGroupAgentObject]

An array of people, workspaces and virtual lines ID's that are added to paging group as paging call targets.

string

Agents ID.

firstName

string

Agent's first name. Minimum length is 1. Maximum length is 64.

lastName

string

Agent's last name. Minimum length is 1. Maximum length is 64.

type

enum

Type of the person, workspace or virtual line.

PEOPLE

string

Indicates that this object is a person.

PLACE

string

Indicates that this object is a workspace, formerly known as a place.

VIRTUAL_LINE

string

Indicates that this object is a virtual line.

phoneNumber

string

Agent's phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.

extension

string

Agent's extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.

routingPrefix

string

Routing prefix of location.

esn

string

Routing prefix + extension of a person or workspace.

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/telephony/config/locations//paging/{?orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Retrieve paging group settings from this organization.

https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg/paging/Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "id": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
    "enabled": true,
    "name": "PagingGroup-1",
    "phoneNumber": "+15558675309",
    "extension": "7781",
    "language": "English",
    "languageCode": "en_us",
    "firstName": "John",
    "lastName": "Doe",
    "originatorCallerIdEnabled": true,
    "originators": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI",
            "firstName": "John",
            "lastName": "Doe",
            "type": "PEOPLE",
            "phoneNumber": "+15558675310",
            "extension": "7781",
            "routingPrefix": "567",
            "esn": "5677781"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=",
            "firstName": "Alice",
            "lastName": "Smith",
            "type": "VIRTUAL_LINE",
            "phoneNumber": "+15558675311",
            "extension": "7782",
            "routingPrefix": "567",
            "esn": "5677781"
        }],
    "targets": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ",
            "firstName": "Alaska Office",
            "lastName": "Second Floor",
            "type": "PLACE",
            "phoneNumber": "+15558675311",
            "extension": "7781",
            "routingPrefix": "567",
            "esn": "5677781"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=",
            "firstName": "Alice",
            "lastName": "Smith",
            "type": "VIRTUAL_LINE",
            "phoneNumber": "+15558675311",
            "extension": "7782",
            "routingPrefix": "567",
            "esn": "5677781"
        }]
}