List responders

Lists the platform's responders: the dial-plan applications and the steps they are made of. A dial rule's dial-rule-application names the responder it starts.

Responders come from two places. The stock catalog ships with the platform and is replaced on every upgrade. Custom entries are your own. A custom entry with the same responder-match as a stock one replaces it entirely, and a custom entry with a new match adds an application. By default (source=effective) the list shows what the call engine uses, and responder-source says where each row comes from: stock, custom or overridden.

Use dial-rule-application when you build a dial rule. It is the short name (such as to-voicemail) where the application has one, otherwise responder-match.

A field of a responder that is not one of the filters below returns 400 rather than being ignored. /responders/count counts the same list.

Requires the Super User or Super User Read Only scope. Office Manager and Reseller read the application list at GET /domains/{domain}/responders.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/responders?source=effective&responder-match=sip%3Astart%40to-%&responder-name=To%20V%&responder-action=check_account&responder-entry-point=yes&responder-source=overridden&dial-rule-application=to-voicemail&sort=responder-name&limit=undefined&start=undefined' \ --header 'Authorization: Bearer <token>'

{ "responder-id": "c2lwOnN0YXJ0QHRvLXZtYWls", "responder-match": "sip:start@to-vmail", "dial-rule-application": "to-voicemail", "responder-name": "To V-Mail", "responder-action": "check_account", "responder-rtp-type": "pcmu", "responder-parameter-0": "SelectUser", "responder-parameter-1": "n/a", "responder-filename": "n/a", "responder-next-0-user": "invalid", "responder-next-0-host": "aa-vmail", "responder-next-1-user": "chk-dest", "responder-next-1-host": "aa-vmail", "responder-entry-point": "yes", "responder-source": "stock" }

Request

Responses