POST /api/v2/callrouters

Creates a new API-based call router.

Rate limit: 1200 per minute.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
routing_url String Yes

The URL that should be used to drive call routing decisions.

name String Yes

[single-line only]

A human-readable display name for the router.

default_target_id Integer Yes

The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails.

enabled Boolean No

If set to False, the call router will skip the routing url and instead forward calls straight to the default target.

default_target_type String Yes

The entity type of the default target.

Possible values:

  • "room"
  • "callrouter"
  • "channel"
  • "coachingteam"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
office_id Integer Yes

The ID of the office to which this router belongs.

secret String No

[single-line only]

The call router's signature secret. This is a plain text string that you should generate with a minimum length of 32 characters.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.