API Reference

Create Chat Campaign (Basic Authentication)

post
https://{domainname}/APIServices/campaignControl/chat

Create a new chat campaign with the provided details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Account username

string

API key for authentication

string

Operation to perform

string

Name of the new chat campaign

string

Campaign type (Chat)

string

Comma-separated list of users for the campaign

string

Primary chat identifier

string

Dynamic identifier

string

Maximum concurrent chats allowed

string

IVR flow name

string

Webhook or push URL for campaign events

string

Where to hit the screen pop URL (e.g., Plugin)

string

Screen pop URL

string

Plugin name used

string

Comma-separated list of disposition values

string

Type of disposition interface

string

Wrap-up time after chat ends (in seconds)

string

Blocking number list or value

string

Comma-separated block number groups

string

Daily outbound limit per number

string

Comma-separated skill names for routing

boolean

Whether transfer skills should be used

string

Comma-separated transfer skills

Headers
string
required
Defaults to application/json
Response

Updated 5 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago