Overview
The Router relies on several underlying settings that determine how messages are delivered, which endpoints are invoked, and how your channels are connected. This page documents the APIs you can use to inspect those configurations.
When calling our APIs we require an authentication token to be present. Please refer to our authentication page for details.
Endpoints
Router version installations
This endpoint returns what versions of the router are configured on your account. Useful for use in a UI when both versions are supported.
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/version-installations
Header: X-CM-PRODUCTTOKEN: 00000000-0000-0000-0000-000000000000
Permissions: ConversationalRouter.Accounts_Read
| Field | Description | Required |
|---|---|---|
| LogicalAccountId | The ID of logical account | Yes |
Response body:
{
"HasV1": true/false,
"HasV2": true/false
}
List applications for account
This endpoint will return all applications configured for a specific account.
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/applications
Header: X-CM-PRODUCTTOKEN: 00000000-0000-0000-0000-000000000000
Permissions: ConversationalRouter.Applications_Read
| Field | Description | Required |
|---|---|---|
| LogicalAccountId | The ID of logical account | Yes |
List application links for a state
Returns all application links configured for a specific state within an account.
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/states/{StateId}/applicationlinks
Header: X-CM-PRODUCTTOKEN: 00000000-0000-0000-0000-000000000000
Permissions: ConversationalRouter.ApplicationLinks_Read
| Field | Description | Required |
|---|---|---|
| LogicalAccountId | The ID of logical account | Yes |
| StateId | The id of state. | Yes |
Get an application link by ID
Returns a single application link by its identifier. Two route variants are available; use either one.
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/states/{StateId}/applicationlinks/{ApplicationLinkId}
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/applicationlinks/{ApplicationLinkId}
Header: X-CM-PRODUCTTOKEN: 00000000-0000-0000-0000-000000000000
Permissions: ConversationalRouter.ApplicationLinks_Read
| Field | Description | Required |
|---|---|---|
| LogicalAccountId | The ID of logical account | Yes |
| StateId | The id of state. | No |
| ApplicationLinkId | The id of application link. | Yes |
List flows for an account
Returns all flows configured for a specific account.
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/flows
Header: X-CM-PRODUCTTOKEN: 00000000-0000-0000-0000-000000000000
Permissions: ConversationalRouter.Flows_Read
| Field | Description | Required |
|---|---|---|
| LogicalAccountId | The ID of logical account | Yes |
Get a flow by ID
Returns a single flow by its identifier within the specified account.
Endpoint: GET https://api.cm.com/router/configuration/v1/accounts/{LogicalAccountId}/flows/{FlowId}
Header: X-CM-PRODUCTTOKEN: 00000000-0000-0000-0000-000000000000
Permissions: ConversationalRouter.Flows_Read
| Field | Description | Required |
|---|---|---|
| LogicalAccountId | The ID of logical account | Yes |
| FlowId | The id of flow. | Yes |