VoipBin API (1.0.0)

Download OpenAPI specification:Download

Accesskey

Operations related to accesskey

Get list of accesskeys

Get accesskeys of the customer

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"token": "string",
"tm_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new accesskey.

Request Body schema: application/json
required

name	string
detail	string
expire	integer <int>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"expire": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"token": "string",
"tm_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get details of an accesskey

path Parameters

id

required

string

ID of the accesskey

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"token": "string",
"tm_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete an accesskey

path Parameters

id

required

string

ID of the accesskey

Responses

Update an accesskey

path Parameters

id

required

string

ID of the accesskey

Request Body schema: application/json
required

name	string
detail	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"token": "string",
"tm_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Activeflow

Operations related to activeflow

Find more about activeflow

Create a new activeflow

Endpoint to create a new activeflow.

Request Body schema: application/json
required

Request body to create a new activeflow.

id	string ID of the activeflow.
flow_id	string Flow id of.
	Array of objects (FlowManagerAction)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"flow_id": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
]
}

Response samples

201

Content type

application/json

{"id": "string",
"customer_id": "string",
"flow_id": "string",
"status": "",
"reference_type": "",
"reference_id": "string",
"current_action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"forward_action_id": "string",
"executed_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List all activeflows

Retrieve a list of all activeflows.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"flow_id": "string",
"status": "",
"reference_type": "",
"reference_id": "string",
"current_action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"forward_action_id": "string",
"executed_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Delete an activeflow

Endpoint to delete an activeflow by its ID.

path Parameters

id

required

string

The ID of the activeflow to delete.

Responses

Get an activeflow by ID

Retrieve details of a specific flow.

path Parameters

id

required

string

The ID of the activeflow.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"flow_id": "string",
"status": "",
"reference_type": "",
"reference_id": "string",
"current_action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"forward_action_id": "string",
"executed_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Stop an activeflow

Endpoint to stop an activeflow by its ID.

path Parameters

id

required

string

The ID of the activeflow to stop.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"flow_id": "string",
"status": "",
"reference_type": "",
"reference_id": "string",
"current_action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"forward_action_id": "string",
"executed_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Agent

Operations related to agent

Find more about agent

List agents

Get agents of the user.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
tag_ids	string Comma separated tag ids.
status	string (AgentManagerAgentStatus) Enum: "" "available" "away" "busy" "offline" "ringing" Agent status.

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new agent

Endpoint to create a new agent.

Request Body schema: application/json
required

Request body to create a new agent.

username required	string
password required	string
name required	string
detail required	string
ring_method required	string (AgentManagerAgentRingMethod) Enum: "ringall" "linear" Represents an agent resource.
permission required	integer <uint64> (AgentManagerAgentPermission) Enum: 0 65535 1 15 16 32 64 240 Permission type
tag_ids required	Array of strings
required	Array of objects (CommonAddress)

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
]
}

Response samples

201

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get the agent

Get the agent of the given ID.

path Parameters

id

required

string

The ID of the agent.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete the agent

Delete the agent of the given ID.

path Parameters

id

required

string

The ID of the agent.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an agent

Update an agent and return updated details.

path Parameters

id

required

string

The ID of the agent.

Request Body schema: application/json
required

name	string
detail	string
ring_method	string (AgentManagerAgentRingMethod) Enum: "ringall" "linear" Represents an agent resource.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"ring_method": "ringall"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an agent's addresses

Update an agent's addresses and return updated details.

path Parameters

id

required

string

The ID of the agent.

Request Body schema: application/json
required

Array of objects (CommonAddress)

Responses

Request samples

Payload

Content type

application/json

{"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an agent's tag IDs

Update an agent's tag IDs and return updated details.

path Parameters

id

required

string

The ID of the agent.

Request Body schema: application/json
required

tag_ids

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"tag_ids": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an agent's permission

Update an agent's permission and return updated details.

path Parameters

id

required

string

The ID of the agent.

Request Body schema: application/json
required

permission

integer <uint64> (AgentManagerAgentPermission)

Enum: 0 65535 1 15 16 32 64 240

Permission type

Responses

Request samples

Payload

Content type

application/json

{"permission": 64
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an agent's status

Update an agent's status and return updated details.

path Parameters

id

required

string

The ID of the agent.

Request Body schema: application/json
required

status

string (AgentManagerAgentStatus)

Enum: "" "available" "away" "busy" "offline" "ringing"

Agent's status

Responses

Request samples

Payload

Content type

application/json

{"status": ""
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an agent's password

Update an agent's password and return updated details.

path Parameters

id

required

string

The ID of the agent.

Request Body schema: application/json
required

password

string

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Billing

Operations related to billing

Find more about billing

Create a new billing account

Creates a new billing account and returns the created account.

Request Body schema: application/json
required

name	string
detail	string
payment_type	string (BillingManagerAccountPaymentType) Enum: "" "prepaid" The type of payment associated with the account.
payment_method	string (BillingManagerAccountPaymentMethod) Enum: "" "credit card" The method of payment used for the account.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"payment_type": "",
"payment_method": ""
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of billing accounts

Retrieves the list of billing accounts associated with the customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Get detailed billing account info

Returns detailed billing account info for the given ID.

path Parameters

id

required

string

The ID of the billing account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete billing account

Deletes the billing account associated with the given ID.

path Parameters

id

required

string

The ID of the billing account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update billing account

Updates the billing account information for the given ID.

path Parameters

id

required

string

The ID of the billing account.

Request Body schema: application/json
required

name	string
detail	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update billing account's payment info

Updates the payment info for the given billing account ID.

path Parameters

id

required

string

The ID of the billing account.

Request Body schema: application/json
required

payment_type	string (BillingManagerAccountPaymentType) Enum: "" "prepaid" The type of payment associated with the account.
payment_method	string (BillingManagerAccountPaymentMethod) Enum: "" "credit card" The method of payment used for the account.

Responses

Request samples

Payload

Content type

application/json

{"payment_type": "",
"payment_method": ""
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Add balance to billing account

Adds the given balance to the billing account.

path Parameters

id

required

string

The ID of the billing account.

Request Body schema: application/json
required

balance

number <float>

Responses

Request samples

Payload

Content type

application/json

{"balance": 0.1
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Subtract balance from billing account

Subtracts the given balance from the billing account.

path Parameters

id

required

string

The ID of the billing account.

Request Body schema: application/json
required

balance

number <float>

Responses

Request samples

Payload

Content type

application/json

{"balance": 0.1
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"balance": 0.1,
"payment_type": "",
"payment_method": "",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of billings

Retrieve a list of the customer's billings.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"account_id": "string",
"status": "progressing",
"reference_type": "",
"reference_id": "string",
"cost_per_unit": 0.1,
"cost_total": 0.1,
"billing_unit_count": 0.1,
"tm_billing_start": "string",
"tm_billing_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Call

Operations related to call

Find more about call

Hang up the call

Ends the call.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Hold the call

Puts the specified call on hold.

path Parameters

id

required

string

Responses

Unhold the call

Removes the hold status on the call.

path Parameters

id

required

string

Responses

Get media stream for the call

Retrieve the media stream information for a specific call.

path Parameters

id

required

string

The ID of the call

query Parameters

encapsulation

string

Responses

Enable Music on Hold (MOH)

Activates Music on Hold for the call.

path Parameters

id

required

string

Responses

Disable Music on Hold (MOH)

Deactivates Music on Hold for the call.

path Parameters

id

required

string

Responses

Mute the call

Mutes the specified call.

path Parameters

id

required

string

Request Body schema: application/json

direction

string (CallManagerCallMuteDirection)

Enum: "" "both" "out" "in"

Possible mute directions for the call

Responses

Request samples

Payload

Content type

application/json

{"direction": ""
}

Unmute the call

Unmutes the specified call.

path Parameters

id

required

string

Request Body schema: application/json

direction

string (CallManagerCallMuteDirection)

Enum: "" "both" "out" "in"

Possible mute directions for the call

Responses

Request samples

Payload

Content type

application/json

{"direction": ""
}

Silence a call

Mute the audio stream for the specified call.

path Parameters

id

required

string

The ID of the call

Responses

Un-silence a call

Unmute the audio stream for the specified call.

path Parameters

id

required

string

The ID of the call

Responses

Talk to the call

Initiates a talking action to the call.

path Parameters

id

required

string

Request Body schema: application/json

text	string
gender	string
language	string

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"gender": "string",
"language": "string"
}

Get detail call info

Returns detailed information about the specified call.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete up the call

Delete the call

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of calls

Returns a list of calls for the given customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Make an outbound call

Creates a temporary flow and initiates a call with the specified flow.

Request Body schema: application/json

flow_id	string
	Array of objects (FlowManagerAction)
	object (CommonAddress) Contains source or destination detail info.
	Array of objects (CommonAddress)

Responses

Request samples

Payload

Content type

application/json

{"flow_id": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
]
}

Response samples

200

Content type

application/json

{"calls": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
],
"groupcalls": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"status": "progressing",
"flow_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"master_call_id": "string",
"master_groupcall_id": "string",
"ring_method": "",
"answer_method": "",
"answer_call_id": "string",
"call_ids": ["string"
],
"answer_groupcall_id": "string",
"groupcall_ids": ["string"
],
"call_count": 0,
"groupcall_count": 0,
"dial_index": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Campaign

Operations related to campaign

Find more about campaign

Get campaign call details

Retrieve detailed information for a specific campaign call.

path Parameters

id

required

string

The ID of the campaign call

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"outplan_id": "string",
"outdial_id": "string",
"outdial_target_id": "string",
"queue_id": "string",
"activeflow_id": "string",
"flow_id": "string",
"reference_type": "none",
"reference_id": "string",
"status": "dialing",
"result": "",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_index": 0,
"try_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a campaign call

Deletes an existing campaign call.

path Parameters

id

required

string

The ID of the campaign call to delete

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"outplan_id": "string",
"outdial_id": "string",
"outdial_target_id": "string",
"queue_id": "string",
"activeflow_id": "string",
"flow_id": "string",
"reference_type": "none",
"reference_id": "string",
"status": "dialing",
"result": "",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_index": 0,
"try_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of campaign calls

Retrieve a list of campaign calls for a given customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"outplan_id": "string",
"outdial_id": "string",
"outdial_target_id": "string",
"queue_id": "string",
"activeflow_id": "string",
"flow_id": "string",
"reference_type": "none",
"reference_id": "string",
"status": "dialing",
"result": "",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_index": 0,
"try_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Update campaign's actions

Updates the actions of a specific campaign and return the updated campaign info.

path Parameters

id

required

string

ID of the campaign

Request Body schema: application/json
required

required

Array of objects (FlowManagerAction)

Responses

Request samples

Payload

Content type

application/json

{"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update campaign's actions

Updates the actions of a specific campaign and return the updated campaign info.

path Parameters

id

required

string

ID of the campaign

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"outplan_id": "string",
"outdial_id": "string",
"outdial_target_id": "string",
"queue_id": "string",
"activeflow_id": "string",
"flow_id": "string",
"reference_type": "none",
"reference_id": "string",
"status": "dialing",
"result": "",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_index": 0,
"try_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Update campaign's service level

Updates the sevice level of a specific campaign and return the updated campaign info.

path Parameters

id

required

string

ID of the campaign

Request Body schema: application/json
required

next_campaign_id

required

string

The next campaign's id.

Responses

Request samples

Payload

Content type

application/json

{"next_campaign_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update campaign's resource info

Updates the resource info of a specific campaign and return the updated campaign info.

path Parameters

id

required

string

ID of the campaign

Request Body schema: application/json
required

outplan_id required	string outplan's id.
outdial_id required	string outplan's id.
queue_id required	string queue's id.
next_campaign_id required	string next campaign's id.

Responses

Request samples

Payload

Content type

application/json

{"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update campaign's service level

Updates the sevice level of a specific campaign and return the updated campaign info.

path Parameters

id

required

string

ID of the campaign

Request Body schema: application/json
required

service_level

required

integer

The campaign's service level.

Responses

Request samples

Payload

Content type

application/json

{"service_level": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update campaign status

Updates the status of a specific campaign.

path Parameters

id

required

string

ID of the campaign

Request Body schema: application/json
required

status

required

string (CampaignManagerCampaignStatus)

Enum: "stop" "stopping" "run"

Status of the campaign.

Responses

Request samples

Payload

Content type

application/json

{"status": "stop"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get campaign details

Retrieves detailed information about a specific campaign by its ID.

path Parameters

id

required

string

ID of the campaign

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a campaign

Updates the details of an existing campaign and returns the updated campaign.

path Parameters

id

required

string

ID of the campaign

Request Body schema: application/json
required

name required	string Updated name of the campaign
detail required	string Updated details of the campaign
type required	string (CampaignManagerCampaignType) Enum: "call" "flow" Type of campaign.
service_level required	integer Updated service level of the campaign
end_handle required	string (CampaignManagerCampaignEndHandle) Enum: "stop" "continue" Behavior of the campaign after outdial has no more targets.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"type": "call",
"service_level": 0,
"end_handle": "stop"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a campaign

Deletes a campaign by its ID.

path Parameters

id

required

string

ID of the campaign

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get a list of campaigns

Retrieves a paginated list of campaigns.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new campaign

Creates a new campaign with the provided details and returns the created campaign.

Request Body schema: application/json
required

name required	string Name of the campaign
detail required	string Detailed description of the campaign
type required	string (CampaignManagerCampaignType) Enum: "call" "flow" Type of campaign.
service_level required	integer Service level of the campaign
end_handle required	string (CampaignManagerCampaignEndHandle) Enum: "stop" "continue" Behavior of the campaign after outdial has no more targets.
required	Array of objects (FlowManagerAction) Actions associated with the campaign
outplan_id required	string Outplan ID for the campaign
outdial_id required	string Outdial ID for the campaign
queue_id required	string Queue ID for the campaign
next_campaign_id required	string ID of the next campaign

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"type": "call",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "call",
"name": "string",
"detail": "string",
"status": "stop",
"service_level": 0,
"end_handle": "stop",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"outplan_id": "string",
"outdial_id": "string",
"queue_id": "string",
"next_campaign_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Chatbot

Operations related to chatbot

Find more about chatbot

Get details of a specific chatbot call

Retrieves detailed information about a chatbot call identified by its ID.

path Parameters

id

required

string

The ID of the chatbot call.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"chatbot_id": "string",
"activeflow_id": "string",
"reference_type": "call",
"reference_id": "string",
"confbridge_id": "string",
"transcribe_id": "string",
"status": "initiating",
"gender": "male",
"language": "string",
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a specific chatbot call

Deletes a chatbot call identified by its ID.

path Parameters

id

required

string

The ID of the chatbot call.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"chatbot_id": "string",
"activeflow_id": "string",
"reference_type": "call",
"reference_id": "string",
"confbridge_id": "string",
"transcribe_id": "string",
"status": "initiating",
"gender": "male",
"language": "string",
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of chatbot calls

Retrieves a paginated list of chatbot calls based on the provided query parameters.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"chatbot_id": "string",
"activeflow_id": "string",
"reference_type": "call",
"reference_id": "string",
"confbridge_id": "string",
"transcribe_id": "string",
"status": "initiating",
"gender": "male",
"language": "string",
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Get chatbot details.

Retrieves detailed information for a specific chatbot by its ID.

path Parameters

id

required

string

The ID of the chatbot.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a chatbot.

Deletes an existing chatbot by its ID.

path Parameters

id

required

string

The ID of the chatbot.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a chatbot.

Updates an existing chatbot's details and returns the updated information.

path Parameters

id

required

string

The ID of the chatbot.

Request Body schema: application/json
required

name required	string
detail required	string
engine_type required	string (ChatbotManagerChatbotEngineType) Enum: "chatGPT" "clova" Type of engine used by the chatbot.
init_prompt required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of chatbots.

Retrieves a paginated list of chatbots.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new chatbot.

Creates a new chatbot and returns the created chatbot's details.

Request Body schema: application/json
required

name required	string
detail required	string
engine_type required	string (ChatbotManagerChatbotEngineType) Enum: "chatGPT" "clova" Type of engine used by the chatbot.
init_prompt required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"engine_type": "chatGPT",
"init_prompt": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Chat

Operations related to chat

Find more about chat

Retrieve details of a chat message

Fetches detailed information about a specific chat message by ID.

path Parameters

id

required

string

The ID of the chat message

Responses

Response samples

200

Content type

application/json

{"id": "string",
"chat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "system",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a chat message

Deletes a specific chat message by ID and returns its details.

path Parameters

id

required

string

The ID of the chat message

Responses

Response samples

200

Content type

application/json

{"id": "string",
"chat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "system",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of chat messages

Fetches a paginated list of chat messages.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
chat_id required	string The chat id.

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"chat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "system",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new chat message

Creates a new chat message and returns the details of the created message.

Request Body schema: application/json
required

chat_id required	string
required	object (CommonAddress) Contains source or destination detail info.
type required	string (ChatManagerMessagechatType) Enum: "system" "normal" Type of the message chat.
text required	string
	Array of objects (ChatManagerMedia)

Responses

Request samples

Payload

Content type

application/json

{"chat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "system",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"chat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "system",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get details of a specific chatroom message

Retrieves detailed information about a chatroom message by its ID.

path Parameters

id

required

string

The ID of the chatroom message

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a chatroom message

Deletes a chatroom message by its ID and returns the deleted message details.

path Parameters

id

required

string

The ID of the chatroom message

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of chatroom messages

Fetches a paginated list of chatroom messages for a specified chatroom.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
chatroom_id required	string The ID of the chatroom

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new chatroom message

Creates a new chatroom message and returns the created message details.

Request Body schema: application/json
required

chatroom_id required	string ID of the chatroom.
text required	string Text of the message.
	Array of objects (ChatManagerMedia) List of media URLs.

Responses

Request samples

Payload

Content type

application/json

{"chatroom_id": "string",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get chatroom details.

Retrieves the details of a specific chatroom by its ID.

path Parameters

id

required

string

The ID of the chatroom.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a chatroom.

Deletes a specific chatroom by its ID and returns the deleted chatroom details.

path Parameters

id

required

string

The ID of the chatroom.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a chatroom.

Updates a specific chatroom's basic information and returns the updated details.

path Parameters

id

required

string

The ID of the chatroom.

Request Body schema: application/json
required

name required	string The new name of the chatroom.
detail required	string The new details of the chatroom.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of chatrooms.

Retrieves a paginated list of chatrooms owned by a specified owner.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
owner_id	string The ID of the chatroom owner.

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new chatroom.

Creates a new chatroom and returns the details of the created chatroom.

Request Body schema: application/json
required

participant_ids required	Array of strings The ID of the participant.
name required	string The name of the chatroom.
detail required	string Additional details of the chatroom.

Responses

Request samples

Payload

Content type

application/json

{"participant_ids": ["string"
],
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Remove a participant from a chat.

Removes a participant ID from a chat.

path Parameters

id required	string The ID of the chat.
participant_id required	string The ID of the participant to remove.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Add a participant to a chat.

Adds a new participant ID to a chat and returns the updated chat details.

path Parameters

id

required

string

The ID of the chat.

Request Body schema: application/json
required

participant_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"participant_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the room owner of a chat.

Updates the room owner ID of a chat.

path Parameters

id

required

string

The ID of the chat to update.

Request Body schema: application/json
required

room_owner_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"room_owner_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get details of a specific chat.

Retrieves detailed information of a chat by its ID.

path Parameters

id

required

string

The ID of the chat.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a chat.

Deletes a chat by its ID.

path Parameters

id

required

string

The ID of the chat to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a chat.

Updates the details of an existing chat by its ID.

path Parameters

id

required

string

The ID of the chat to update.

Request Body schema: application/json
required

name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of chats.

Retrieves a paginated list of chats based on query parameters.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new chat.

Creates a new chat with the provided information and returns the created chat details.

Request Body schema: application/json
required

type required	string (ChatManagerChatType) Enum: "normal" "group" Type of the chat.
owner_id required	string
participant_ids required	Array of strings
name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "normal",
"owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "normal",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Conference

Operations related to conference

Find more about conference

Get conference call details

Retrieve detailed information about a specific conference call using its ID.

path Parameters

id

required

string

The ID of the conferencecall.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"conference_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "joining",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Remove a conference call

Remove a specific conference call from the system by its ID.

path Parameters

id

required

string

The ID of the conferencecall to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"conference_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "joining",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of conference calls

Retrieve a paginated list of conference calls for the authenticated customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"conference_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "joining",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Start media streaming for a conference

Start the in/out media streaming of the specified conference.

path Parameters

id

required

string

The ID of the conference

query Parameters

encapsulation

required

string

Example: encapsulation=mediasocket

The encapsulation for media stream.

Responses

Start conference recording

Initiate recording for the specified conference.

path Parameters

id

required

string

The ID of the conference

Responses

Stop conference recording

Stop the ongoing recording for the specified conference.

path Parameters

id

required

string

The ID of the conference

Responses

Start conference transcription

Begin transcription for the specified conference.

path Parameters

id

required

string

The ID of the conference

Request Body schema: application/json
required

language

required

string

The language for transcription.

Responses

Request samples

Payload

Content type

application/json

{"language": "en-US"
}

Stop conference transcription

Stop the ongoing transcription for the specified conference.

path Parameters

id

required

string

The ID of the conference

Responses

Get conference details

Retrieve detailed information about a specific conference.

path Parameters

id

required

string

The ID of the conference

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "",
"status": "starting",
"name": "string",
"detail": "string",
"data": { },
"timeout": 0,
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"conferencecall_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"transcribe_id": "string",
"transcribe_ids": ["string"
],
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update conference details

Update the details of a specific conference.

path Parameters

id

required

string

The ID of the conference

Request Body schema: application/json
required

name required	string
detail required	string
timeout required	integer
required	Array of objects (FlowManagerAction)
required	Array of objects (FlowManagerAction)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"timeout": 0,
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "",
"status": "starting",
"name": "string",
"detail": "string",
"data": { },
"timeout": 0,
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"conferencecall_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"transcribe_id": "string",
"transcribe_ids": ["string"
],
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a conference

Delete a specific conference. All participants will be removed.

path Parameters

id

required

string

The ID of the conference

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "",
"status": "starting",
"name": "string",
"detail": "string",
"data": { },
"timeout": 0,
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"conferencecall_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"transcribe_id": "string",
"transcribe_ids": ["string"
],
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of conferences

Retrieve a paginated list of conferences for the customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"type": "",
"status": "starting",
"name": "string",
"detail": "string",
"data": { },
"timeout": 0,
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"conferencecall_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"transcribe_id": "string",
"transcribe_ids": ["string"
],
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new conference

Create a new conference with the provided details.

Request Body schema: application/json
required

type required	string (ConferenceManagerConferenceType) Enum: "" "conference" "connect" "queue" Types of conferences.
name required	string
detail required	string
timeout required	integer
data required	object
required	Array of objects (FlowManagerAction)
required	Array of objects (FlowManagerAction)

Responses

Request samples

Payload

Content type

application/json

{"type": "",
"name": "string",
"detail": "string",
"timeout": 0,
"data": { },
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "",
"status": "starting",
"name": "string",
"detail": "string",
"data": { },
"timeout": 0,
"pre_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"post_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"conferencecall_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"transcribe_id": "string",
"transcribe_ids": ["string"
],
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Conversation

Operations related to conversation

Find more about conversation

Get details of a conversation account

Fetches details of the conversation account specified by ID.

path Parameters

id

required

string

The ID of the conversation account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "line",
"name": "string",
"detail": "string",
"secret": "string",
"token": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a conversation account

Updates the details of the conversation account specified by ID.

path Parameters

id

required

string

The ID of the conversation account.

Request Body schema: application/json
required

name required	string
detail required	string
secret required	string
token required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"secret": "string",
"token": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "line",
"name": "string",
"detail": "string",
"secret": "string",
"token": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a conversation account

Deletes the conversation account specified by ID.

path Parameters

id

required

string

The ID of the conversation account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "line",
"name": "string",
"detail": "string",
"secret": "string",
"token": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of conversation accounts

Fetches a paginated list of conversation accounts.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"type": "line",
"name": "string",
"detail": "string",
"secret": "string",
"token": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new conversation account

Creates a new conversation account and returns its details.

Request Body schema: application/json
required

type required	string (ConversationManagerAccountType) Enum: "line" "sms" Type of the account.
name required	string
detail required	string
secret required	string
token required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "line",
"name": "string",
"detail": "string",
"secret": "string",
"token": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "line",
"name": "string",
"detail": "string",
"secret": "string",
"token": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of conversation messages

Gets a paginated list of messages for a specific conversation.

path Parameters

id

required

string

The ID of the conversation.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"conversation_id": "string",
"direction": "outgoing",
"status": "sending",
"reference_type": "none",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"text": "string",
"medias": [{"id": "string",
"customer_id": "string",
"type": "image",
"filename": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Send a message

Sends a message to a specific conversation and returns the sent message info.

path Parameters

id

required

string

The ID of the conversation.

Request Body schema: application/json
required

text required	string The message text.
required	Array of objects (ConversationManagerMedia)

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"medias": [{"id": "string",
"customer_id": "string",
"type": "image",
"filename": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"conversation_id": "string",
"direction": "outgoing",
"status": "sending",
"reference_type": "none",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"text": "string",
"medias": [{"id": "string",
"customer_id": "string",
"type": "image",
"filename": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Returns detailed conversation info

Returns detailed information about a specific conversation by its ID.

path Parameters

id

required

string

The ID of the conversation.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"account_id": "string",
"name": "string",
"detail": "string",
"reference_type": "",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"participants": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update conversation info

Updates the details of a specific conversation by its ID.

path Parameters

id

required

string

The ID of the conversation.

Request Body schema: application/json
required

name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"account_id": "string",
"name": "string",
"detail": "string",
"reference_type": "",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"participants": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of conversations

Gets a list of conversations with pagination.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"account_id": "string",
"name": "string",
"detail": "string",
"reference_type": "",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"participants": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Customer

Operations related to customer

Find more about customer

Update a customer's billing account ID

Modify the billing account ID associated with a customer.

Request Body schema: application/json
required

Billing account update payload

billing_account_id

required

string

The new billing account ID for the customer.

Responses

Request samples

Payload

Content type

application/json

{"billing_account_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get customer info

Retrieve the information of the customer.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a customer

Update the information of a customer and retrieve the updated details.

Request Body schema: application/json
required

Customer update payload

name required	string The new name of the customer.
detail required	string Additional details about the customer.
email required	string The customer's email address.
phone_number required	string The customer's phone number.
address required	string The customer's address.
webhook_method required	string (CustomerManagerCustomerWebhookMethod) Enum: "" "POST" "GET" "PUT" "DELETE" The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).
webhook_uri required	string Webhook URI.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a customer's billing account ID.

Updates the billing account ID for a specific customer.

path Parameters

id

required

string

Request Body schema: application/json
required

billing_account_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"billing_account_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve customer details.

Fetches detailed information about a specific customer by their ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a customer.

Updates the details of an existing customer and returns the updated information.

path Parameters

id

required

string

Request Body schema: application/json
required

name required	string
detail required	string
email required	string
phone_number required	string
address required	string
webhook_method required	string (CustomerManagerCustomerWebhookMethod) Enum: "" "POST" "GET" "PUT" "DELETE" The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).
webhook_uri required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a customer.

Removes a customer by their ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of customers.

Retrieves a paginated list of customers.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new customer.

Creates a new customer with the provided details and returns the created customer.

Request Body schema: application/json
required

name required	string
detail required	string
email required	string
phone_number required	string
address required	string
webhook_method required	string (CustomerManagerCustomerWebhookMethod) Enum: "" "POST" "GET" "PUT" "DELETE" The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).
webhook_uri required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Extension

Operations related to extension

Find more about extension

Get extension details

Retrieves details of a specific extension by its ID.

path Parameters

id

required

string

The ID of the extension.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an extension

Updates an existing extension and returns the updated details.

path Parameters

id

required

string

The ID of the extension.

Request Body schema: application/json
required

name required	string
detail required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete an extension

Deletes an existing extension by its ID.

path Parameters

id

required

string

The ID of the extension.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get a list of extensions

Retrieves a list of extensions.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new extension

Creates a new extension and returns its details.

Request Body schema: application/json
required

extension required	string
password required	string
name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"extension": "string",
"password": "string",
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

File

Operations related to file

Returns detail file info

Retrieves detailed information about a file by its ID.

path Parameters

id

required

string

The ID of the file.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a file

Deletes a file identified by its ID.

path Parameters

id

required

string

The ID of the file.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Gets a list of files

Retrieves a paginated list of files.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Upload file

Upload file.

Request Body schema: multipart/form-data
required

file

required

string <binary>

The file to be uploaded.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Flow

Operations related to flow

Find more about flow

Retrieve flow details

Retrieves the details of a specific flow by its ID.

path Parameters

id

required

string

The ID of the flow.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "flow",
"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a flow

Updates the details of an existing flow and returns the updated information.

path Parameters

id

required

string

The ID of the flow.

Request Body schema: application/json
required

name required	string The updated name of the flow.
detail required	string The updated details of the flow.
required	Array of objects (FlowManagerAction) Updated list of actions associated with the flow.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "flow",
"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a flow

Deletes an existing flow by its ID.

path Parameters

id

required

string

The ID of the flow.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "flow",
"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of flows

Retrieves a paginated list of flows accessible to the authenticated agent.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"type": "flow",
"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new flow

Creates a new flow with the provided details and returns the created flow's information.

Request Body schema: application/json
required

name required	string The name of the flow.
detail required	string Detailed information about the flow.
required	Array of objects (FlowManagerAction) List of actions associated with the flow.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "flow",
"name": "string",
"detail": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Groupcall

Operations related to groupcall

Find more about groupcall

Hangup the groupcall

Ends the groupcall with the specified ID.

path Parameters

id

required

string

The ID of the groupcall.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"status": "progressing",
"flow_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"master_call_id": "string",
"master_groupcall_id": "string",
"ring_method": "",
"answer_method": "",
"answer_call_id": "string",
"call_ids": ["string"
],
"answer_groupcall_id": "string",
"groupcall_ids": ["string"
],
"call_count": 0,
"groupcall_count": 0,
"dial_index": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get detailed information of a groupcall

Returns the details of the groupcall with the specified ID.

path Parameters

id

required

string

The ID of the groupcall.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"status": "progressing",
"flow_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"master_call_id": "string",
"master_groupcall_id": "string",
"ring_method": "",
"answer_method": "",
"answer_call_id": "string",
"call_ids": ["string"
],
"answer_groupcall_id": "string",
"groupcall_ids": ["string"
],
"call_count": 0,
"groupcall_count": 0,
"dial_index": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a groupcall

Deletes the groupcall with the specified ID.

path Parameters

id

required

string

The ID of the groupcall.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"status": "progressing",
"flow_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"master_call_id": "string",
"master_groupcall_id": "string",
"ring_method": "",
"answer_method": "",
"answer_call_id": "string",
"call_ids": ["string"
],
"answer_groupcall_id": "string",
"groupcall_ids": ["string"
],
"call_count": 0,
"groupcall_count": 0,
"dial_index": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get a list of groupcalls

Retrieves a list of groupcalls based on the provided parameters.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"status": "progressing",
"flow_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"master_call_id": "string",
"master_groupcall_id": "string",
"ring_method": "",
"answer_method": "",
"answer_call_id": "string",
"call_ids": ["string"
],
"answer_groupcall_id": "string",
"groupcall_ids": ["string"
],
"call_count": 0,
"groupcall_count": 0,
"dial_index": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new groupcall

Creates a new groupcall with the specified information and returns the created groupcall.

Request Body schema: application/json

required	object (CommonAddress) Contains source or destination detail info.
required	Array of objects (CommonAddress)
flow_id required	string
required	Array of objects (FlowManagerAction)
ring_method required	string (CallManagerGroupcallRingMethod) Enum: "" "ring_all" "linear" Method used for dialing
answer_method required	string (CallManagerGroupcallAnswerMethod) Enum: "" "hangup_others" Method to handle answered calls

Responses

Request samples

Payload

Content type

application/json

{"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"flow_id": "string",
"actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"ring_method": "",
"answer_method": ""
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"status": "progressing",
"flow_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"master_call_id": "string",
"master_groupcall_id": "string",
"ring_method": "",
"answer_method": "",
"answer_call_id": "string",
"call_ids": ["string"
],
"answer_groupcall_id": "string",
"groupcall_ids": ["string"
],
"call_count": 0,
"groupcall_count": 0,
"dial_index": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Me

Operations related to myself data

Get the logged-in agent

Retrieves the information of the currently logged-in agent.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Message

Operations related to message

Find more about message

Get a message by ID

Retrieves the message of the given ID.

path Parameters

id

required

string

The ID of the message.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "sms",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"targets": [{"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "received",
"parts": 0,
"tm_update": "string"
}
],
"text": "string",
"direction": "outbound",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a message by ID

Deletes the message with the given ID and returns the deleted message.

path Parameters

id

required

string

The ID of the message to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "sms",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"targets": [{"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "received",
"parts": 0,
"tm_update": "string"
}
],
"text": "string",
"direction": "outbound",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List all messages

Retrieves a list of messages for the given customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"type": "sms",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"targets": [{"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "received",
"parts": 0,
"tm_update": "string"
}
],
"text": "string",
"direction": "outbound",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Send a message and return the sent message

Sends a message with the provided information and returns the sent message details.

Request Body schema: application/json

required	object (CommonAddress) Contains source or destination detail info.
required	Array of objects (CommonAddress) List of destinations for the message.
text required	string The content of the message.

Responses

Request samples

Payload

Content type

application/json

{"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destinations": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"text": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "sms",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"targets": [{"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "received",
"parts": 0,
"tm_update": "string"
}
],
"text": "string",
"direction": "outbound",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Number

Operations related to number

Find more about number

List available numbers

Get available phone numbers for the specified country.

query Parameters

page_size	integer The size of results.
country_code required	string The ISO country code.

Responses

Response samples

200

Content type

application/json

{"result": ["emergency"
]
}

Update the order number's flow ID

Update the flow ID of the order number identified by the provided ID.

path Parameters

id

required

string

The ID of the order number to update.

Request Body schema: application/json

call_flow_id required	string The ID of the updated call flow.
message_flow_id required	string The ID of the updated message flow.

Responses

Request samples

Payload

Content type

application/json

{"call_flow_id": "string",
"message_flow_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get order number by ID

Get the details of the order number identified by the provided ID.

path Parameters

id

required

string

The ID of the order number.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete order number by ID

Delete the order number identified by the provided ID.

path Parameters

id

required

string

The ID of the order number to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update order number by ID

Update the order number's details with the provided information.

path Parameters

id

required

string

The ID of the order number to update.

Request Body schema: application/json

call_flow_id required	string The ID of the updated call flow.
message_flow_id required	string The ID of the updated message flow.
name required	string The updated name of the number.
detail required	string Updated details for the number.

Responses

Request samples

Payload

Content type

application/json

{"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List order numbers

Get a list of order numbers based on the customer's information.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new number

Create a new order number and return the details of the created number.

Request Body schema: application/json
required

number required	string The phone number.
call_flow_id required	string The ID of the call flow.
message_flow_id required	string The ID of the message flow.
name required	string The name of the number.
detail required	string Additional details about the number.

Responses

Request samples

Payload

Content type

application/json

{"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Renew the numbers

Renew the specified numbers and return the updated number details.

Request Body schema: application/json

tm_renew

required

string

The timestamp for renewing the number.

Responses

Request samples

Payload

Content type

application/json

{"tm_renew": "string"
}

Response samples

200

Content type

application/json

[{"id": "string",
"customer_id": "string",
"number": "string",
"call_flow_id": "string",
"message_flow_id": "string",
"name": "string",
"detail": "string",
"status": "active",
"t38_enabled": true,
"emergency_enabled": true,
"tm_purchase": "string",
"tm_renew": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]

Outdial

Operations related to outdial

Find more about outdial

Update an outdial's campaign ID.

Updates the campaign ID of the specified outdial and returns the updated outdial information.

path Parameters

id

required

string

The ID of the outdial to update.

Request Body schema: application/json

campaign_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"campaign_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an outdial's data.

Updates the data of the specified outdial and returns the updated outdial details.

path Parameters

id

required

string

The ID of the outdial to update.

Request Body schema: application/json

data

required

string

Responses

Request samples

Payload

Content type

application/json

{"data": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve an outdial target by its ID.

Gets the details of a specific outdial target using its ID.

path Parameters

id required	string The ID of the outdial.
target_id required	string The ID of the outdial target.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"outdial_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"status": "progressing",
"destination_0": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_1": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_2": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_3": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_4": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"try_count_0": 0,
"try_count_1": 0,
"try_count_2": 0,
"try_count_3": 0,
"try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete an outdial target.

Deletes a specific outdial target based on its ID.

path Parameters

id required	string The ID of the outdial to delete the target from.
target_id required	string The ID of the target to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"outdial_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"status": "progressing",
"destination_0": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_1": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_2": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_3": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_4": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"try_count_0": 0,
"try_count_1": 0,
"try_count_2": 0,
"try_count_3": 0,
"try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of outdial targets.

Gets a list of outdial targets based on the specified page size and page token.

path Parameters

id

required

string

The ID of the outdial to associate with the target.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"outdial_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"status": "progressing",
"destination_0": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_1": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_2": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_3": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_4": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"try_count_0": 0,
"try_count_1": 0,
"try_count_2": 0,
"try_count_3": 0,
"try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new target for an outdial.

Creates a new target for the specified outdial and returns the created target information.

path Parameters

id

required

string

The ID of the outdial to associate with the target.

Request Body schema: application/json

name required	string
detail required	string
data required	string
required	object (CommonAddress) Contains source or destination detail info.
required	object (CommonAddress) Contains source or destination detail info.
required	object (CommonAddress) Contains source or destination detail info.
required	object (CommonAddress) Contains source or destination detail info.
required	object (CommonAddress) Contains source or destination detail info.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"data": "string",
"destination_0": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_1": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_2": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_3": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_4": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"outdial_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"status": "progressing",
"destination_0": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_1": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_2": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_3": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination_4": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"try_count_0": 0,
"try_count_1": 0,
"try_count_2": 0,
"try_count_3": 0,
"try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve an outdial by its ID.

Returns detailed information of a specific outdial based on the provided ID.

path Parameters

id

required

string

The ID of the outdial to retrieve.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete an existing outdial.

Deletes an outdial specified by its ID.

path Parameters

id

required

string

The ID of the outdial to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update an outdial.

Updates the specified outdial and returns the updated information.

path Parameters

id

required

string

The ID of the outdial to update.

Request Body schema: application/json

name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of outdials.

Gets a list of outdials based on the specified page size and page token.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new outdial.

Creates a new outdial with the specified information and returns the created outdial details.

Request Body schema: application/json

campaign_id required	string
name required	string
detail required	string
data required	string

Responses

Request samples

Payload

Content type

application/json

{"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"campaign_id": "string",
"name": "string",
"detail": "string",
"data": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Outplan

Operations related to outplan

Find more about outplan

Update dial information of an existing outplan.

Updates the dial information for the outplan specified by the given ID and returns the updated outplan.

path Parameters

id

required

string

The ID of the outplan to update.

Request Body schema: application/json
required

required	object (CommonAddress) Contains source or destination detail info.
dial_timeout required	integer The new dial timeout in seconds.
try_interval required	integer The new interval between retry attempts.
max_try_count_0 required	integer The new maximum retry count for destination 0.
max_try_count_1 required	integer The new maximum retry count for destination 1.
max_try_count_2 required	integer The new maximum retry count for destination 2.
max_try_count_3 required	integer The new maximum retry count for destination 3.
max_try_count_4 required	integer The new maximum retry count for destination 4.

Responses

Request samples

Payload

Content type

application/json

{"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve outplan details by ID.

Retrieves the details of the specified outplan based on the given ID.

path Parameters

id

required

string

The unique identifier of the outplan.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete an existing outplan.

Deletes the outplan specified by the given ID.

path Parameters

id

required

string

The ID of the outplan to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update dial information of an existing outplan.

Updates the dial information for the outplan specified by the given ID and returns the updated outplan.

path Parameters

id

required

string

The ID of the outplan to update.

Request Body schema: application/json
required

name required	string The new name of the outplan.
detail required	string The new detail of the outplan.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of outplans.

Retrieves a paginated list of outplans based on the provided parameters.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new outplan.

Creates a new outplan with the provided details and returns the created outplan.

Request Body schema: application/json
required

name required	string The name of the outplan.
detail required	string Additional details about the outplan.
required	object (CommonAddress) Contains source or destination detail info.
dial_timeout required	integer The dial timeout in seconds.
try_interval required	integer The interval between retry attempts.
max_try_count_0 required	integer Maximum retry count for destination 0.
max_try_count_1 required	integer Maximum retry count for destination 1.
max_try_count_2 required	integer Maximum retry count for destination 2.
max_try_count_3 required	integer Maximum retry count for destination 3.
max_try_count_4 required	integer Maximum retry count for destination 4.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"dial_timeout": 0,
"try_interval": 0,
"max_try_count_0": 0,
"max_try_count_1": 0,
"max_try_count_2": 0,
"max_try_count_3": 0,
"max_try_count_4": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Provider

Operations related to provider

Find more about provider

Get provider by ID

Retrieves the provider details for the specified ID.

path Parameters

id

required

string

The ID of the provider

Responses

Response samples

200

Content type

application/json

{"id": "string",
"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": {"property1": "string",
"property2": "string"
},
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete provider by ID

Deletes the provider with the specified ID.

path Parameters

id

required

string

The ID of the provider to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": {"property1": "string",
"property2": "string"
},
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update provider information

Updates the provider details for the given ID with the provided information.

path Parameters

id

required

string

The ID of the provider to update.

Request Body schema: application/json

type required	string (RouteManagerProviderType) Value: "sip" Defines the type of the provider. Currently, only 'sip' is supported for VoIP/SIP providers.
hostname required	string
tech_prefix required	string
tech_postfix required	string
tech_headers required	object
name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": { },
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": {"property1": "string",
"property2": "string"
},
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List providers of the given customer

Returns a list of providers for the authenticated customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": {"property1": "string",
"property2": "string"
},
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new provider

Creates a new provider with the provided details.

Request Body schema: application/json

type required	string (RouteManagerProviderType) Value: "sip" Defines the type of the provider. Currently, only 'sip' is supported for VoIP/SIP providers.
hostname required	string
tech_prefix required	string
tech_postfix required	string
tech_headers required	object
name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": { },
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"type": "sip",
"hostname": "string",
"tech_prefix": "string",
"tech_postfix": "string",
"tech_headers": {"property1": "string",
"property2": "string"
},
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Queue

Operations related to queue

Find more about queue

Kick a queue call from the queue

Removes the specified queue call from the queue.

path Parameters

id

required

string

The ID of the queue call.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"service_agent_id": "string",
"duration_waiting": 0,
"duration_service": 0,
"tm_create": "string",
"tm_service": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get detailed queue call information

Returns detailed information for the specified queue call ID.

path Parameters

id

required

string

The ID of the queue call.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"service_agent_id": "string",
"duration_waiting": 0,
"duration_service": 0,
"tm_create": "string",
"tm_service": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a queue call

Deletes the specified queue call.

path Parameters

id

required

string

The ID of the queue call to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"service_agent_id": "string",
"duration_waiting": 0,
"duration_service": 0,
"tm_create": "string",
"tm_service": "string",
"tm_update": "string",
"tm_delete": "string"
}

List queue calls

Returns a list of queue calls for the given customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"service_agent_id": "string",
"duration_waiting": 0,
"duration_service": 0,
"tm_create": "string",
"tm_service": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Kick a queue call by reference ID

Removes the queue call associated with the given reference ID from the queue.

path Parameters

id

required

string

The reference ID of the queue call.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"service_agent_id": "string",
"duration_waiting": 0,
"duration_service": 0,
"tm_create": "string",
"tm_service": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the queue's action handle

Updates the action handle of the specified queue.

path Parameters

id

required

string

Request Body schema: application/json

required	Array of objects (FlowManagerAction)
timeout_wait required	integer
timeout_service required	integer

Responses

Request samples

Payload

Content type

application/json

{"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"timeout_wait": 0,
"timeout_service": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the queue's routing method

Updates the routing method of the specified queue.

path Parameters

id

required

string

Request Body schema: application/json

routing_method

required

string (QueueManagerQueueRoutingMethod)

Enum: "" "random"

Responses

Request samples

Payload

Content type

application/json

{"routing_method": ""
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the queue's tag IDs

Updates the tag IDs of the specified queue.

path Parameters

id

required

string

Request Body schema: application/json

tag_ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"tag_ids": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get the queue by ID

Retrieves the details of a specific queue by its ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a queue by ID

Deletes the queue specified by the given ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the queue details

Updates the details of the queue identified by the given ID.

path Parameters

id

required

string

Request Body schema: application/json
required

name required	string
detail required	string
routing_method required	string (QueueManagerQueueRoutingMethod) Enum: "" "random"
tag_ids required	Array of strings
required	Array of objects (FlowManagerAction)
wait_timeout required	integer
service_timeout required	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List queues of the customer

Retrieves a list of queues associated with the customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new queue

Creates a new queue with the provided details.

Request Body schema: application/json

name required	string
detail required	string
routing_method required	string (QueueManagerQueueRoutingMethod) Enum: "" "random"
tag_ids required	Array of strings
required	Array of objects (FlowManagerAction)
wait_timeout required	integer
service_timeout required	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"routing_method": "",
"tag_ids": ["string"
],
"wait_actions": [{"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
}
],
"wait_timeout": 0,
"service_timeout": 0,
"wait_queuecall_ids": ["string"
],
"service_queuecall_ids": ["string"
],
"total_incoming_count": 0,
"total_serviced_count": 0,
"total_abandoned_count": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Recording

Operations related to recording

Find more about recording

Download the recording file

Retrieves the specified recording file and redirects to the download URI.

path Parameters

id

required

string

The recording file's ID.

Responses

Response samples

307
400
404

Content type

application/json

"string"

Get recording details

Retrieves detailed information about a specific recording.

path Parameters

id

required

string

The recording's ID.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"format": "wav",
"tm_start": "string",
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete recording

Deletes the specified recording and returns the deleted recording information.

path Parameters

id

required

string

The recording's ID.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"format": "wav",
"tm_start": "string",
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List recordings

Retrieves a list of recordings for the given customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"reference_type": "call",
"reference_id": "string",
"status": "initiating",
"format": "wav",
"tm_start": "string",
"tm_end": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Route

Operations related to route

Find more about route

Get a route

Returns the details of the route for the given ID.

path Parameters

id

required

string

The route's ID.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete the route

Deletes the route for the given ID.

path Parameters

id

required

string

The route's ID.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a route

Updates a route with the provided details and returns the updated route.

path Parameters

id

required

string

The route's ID.

Request Body schema: application/json
required

name required	string The name of the route.
detail required	string The detail information of the route.
provider_id required	string The provider ID for the route.
priority required	integer The priority of the route.
target required	string The target of the route.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List routes

Returns a list of routes for the given customer with pagination.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
customer_id	string target customer id

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new route

Creates a new route with the provided details.

Request Body schema: application/json
required

customer_id required	string The ID of the customer for the route.
name required	string The name of the route.
detail required	string The detail information of the route.
provider_id required	string The provider ID for the route.
priority required	integer The priority of the route.
target required	string The target of the route.

Responses

Request samples

Payload

Content type

application/json

{"customer_id": "string",
"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"provider_id": "string",
"priority": 0,
"target": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Service Agent

Operations related to individual agent service

Retrieve detailed information of a service agent

Fetches detailed information of a specific service agent by its ID.

path Parameters

id

required

string

The ID of the service agent.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of service agents

Fetches a list of service agents with pagination support.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Retrieve detailed information of a specific call

Fetches detailed information about a specific call by its ID.

path Parameters

id

required

string

The ID of the call.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of calls for the given customer

Fetches a list of calls for the given service agent, with pagination support.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"flow_id": "string",
"activeflow_id": "string",
"type": "",
"master_call_id": "string",
"chained_call_ids": ["string"
],
"recording_id": "string",
"recording_ids": ["string"
],
"groupcall_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"destination": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"status": "dialing",
"action": {"id": "string",
"next_id": "string",
"type": "amd",
"option": { },
"tm_execute": "string"
},
"direction": "incoming",
"mute_direction": "",
"hangup_by": "",
"hangup_reason": "",
"tm_progressing": "string",
"tm_ringing": "string",
"tm_hangup": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Retrieve detailed information of a specific chatroom message

Fetches detailed information about a specific chatroom message by its ID.

path Parameters

id

required

string

The ID of the chatroom message.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a specific chatroom message

Deletes a specific chatroom message by its ID and returns the deleted message info.

path Parameters

id

required

string

The ID of the chatroom message to delete.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Create a new chatroom message

Creates a new chatroom message with the given information and returns the created message.

Request Body schema: application/json
required

chatroom_id required	string
text required	string
required	Array of objects (ChatManagerMedia)

Responses

Request samples

Payload

Content type

application/json

{"chatroom_id": "string",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of chatroom messages

Retrieves a list of chatroom messages for a specific chatroom, with pagination support.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
chatroom_id required	string The ID of the chatroom to retrieve messages for.

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"chatroom_id": "string",
"messagechat_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"type": "",
"text": "string",
"medias": [{"type": "address",
"address": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"agent": {"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
},
"file_id": "string",
"link_url": "http://example.com"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Get detailed information of a chatroom

Returns detailed information of the chatroom identified by the given ID.

path Parameters

id

required

string

The ID of the chatroom

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a chatroom and return the deleted chatroom's details

Deletes the chatroom identified by the given ID and returns the deleted chatroom's details.

path Parameters

id

required

string

The ID of the chatroom

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the chatroom and return the updated information

Updates the chatroom identified by the given ID and returns the updated chatroom's details.

path Parameters

id

required

string

The ID of the chatroom

Request Body schema: application/json

name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of chatrooms

Returns a list of chatrooms for the given customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new chatroom and return the created chatroom's details

Creates a new chatroom for the given customer and returns the created chatroom's details.

Request Body schema: application/json

participant_ids required	Array of strings
name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"participant_ids": ["string"
],
"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_type": "string",
"owner_id": "string",
"type": "unknown",
"chat_id": "string",
"room_owner_id": "string",
"participant_ids": ["string"
],
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of conversation messages

Retrieves a paginated list of messages for a specific conversation.

path Parameters

id

required

string

The ID of the conversation.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"conversation_id": "string",
"direction": "outgoing",
"status": "sending",
"reference_type": "none",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"text": "string",
"medias": [{"id": "string",
"customer_id": "string",
"type": "image",
"filename": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Send a message to the conversation

Sends a message to a specific conversation and returns the details of the sent message.

path Parameters

id

required

string

The ID of the conversation.

Request Body schema: application/json
required

The details of the message to be sent.

text required	string The text content of the message.
required	Array of objects (ConversationManagerMedia)

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"medias": [{"id": "string",
"customer_id": "string",
"type": "image",
"filename": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"conversation_id": "string",
"direction": "outgoing",
"status": "sending",
"reference_type": "none",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"text": "string",
"medias": [{"id": "string",
"customer_id": "string",
"type": "image",
"filename": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get detailed conversation info

Retrieves detailed information about a specific conversation by its ID.

path Parameters

id

required

string

The ID of the conversation.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"account_id": "string",
"name": "string",
"detail": "string",
"reference_type": "",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"participants": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of conversations

Retrieves a paginated list of conversations associated with the authenticated agent.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"account_id": "string",
"name": "string",
"detail": "string",
"reference_type": "",
"reference_id": "string",
"source": {"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
},
"participants": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Get customer details

Retrieves detailed information about the customer associated with the authenticated agent.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"email": "string",
"phone_number": "string",
"address": "string",
"webhook_method": "",
"webhook_uri": "string",
"billing_account_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get extension details

Retrieves detailed information about a specific extension by its ID.

path Parameters

id

required

string

The ID of the extension.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of extensions

Retrieves a paginated list of extensions associated with the authenticated agent.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"extension": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Get file details

Retrieves detailed information about a specific file by its ID.

path Parameters

id

required

string

The ID of the file.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a file

Deletes a specific file by its ID.

path Parameters

id

required

string

The ID of the file.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Upload a file

Uploads a file and returns the details of the uploaded file.

Request Body schema: multipart/form-data
required

file

required

string <binary>

The file to upload.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of files

Retrieves a paginated list of files associated with the authenticated agent.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Update authenticated agent's addresses

Updates the address details of the authenticated agent and returns the updated information.

Request Body schema: application/json
required

required

Array of objects (CommonAddress)

The updated list of addresses.

Responses

Request samples

Payload

Content type

application/json

{"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update authenticated agent's password

Updates the password of the authenticated agent.

Request Body schema: application/json
required

password

required

string

The new password for the agent.

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update authenticated agent's status

Updates the status of the authenticated agent and returns the updated information.

Request Body schema: application/json
required

status

required

string (AgentManagerAgentStatus)

Enum: "" "available" "away" "busy" "offline" "ringing"

Agent's status

Responses

Request samples

Payload

Content type

application/json

{"status": ""
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get authenticated agent's details

Retrieves detailed information about the authenticated agent.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update authenticated agent's information

Updates the basic information of the authenticated agent and returns the updated details.

Request Body schema: application/json
required

name required	string The updated name of the agent.
detail required	string Additional details about the agent.
ring_method required	string (AgentManagerAgentRingMethod) Enum: "ringall" "linear" Represents an agent resource.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"ring_method": "ringall"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"username": "string",
"name": "string",
"detail": "string",
"ring_method": "ringall",
"status": "",
"permission": 64,
"tag_ids": ["string"
],
"addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Establish a WebSocket connection

Creates a new WebSocket connection for the authenticated agent.

Storage

Operations related to storage

Find more about storage

Get details of a given account's storage account

Retrieves the details of a given account's storage account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"total_file_count": 0,
"total_file_size": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get details of a specific storage account

Retrieves the details of a specific storage account by its ID.

path Parameters

id

required

string

The ID of the storage account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"total_file_count": 0,
"total_file_size": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a specific storage account

Deletes a specific storage account by its ID and returns the details of the deleted account.

path Parameters

id

required

string

The ID of the storage account.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"total_file_count": 0,
"total_file_size": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get a list of storage accounts

Retrieves a list of storage accounts with the provided pagination details.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"total_file_count": 0,
"total_file_size": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new storage account

Creates a new storage account with the provided information and returns the created account details.

Request Body schema: application/json

customer_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"customer_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"total_file_count": 0,
"total_file_size": 0,
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get file details by ID

Retrieves detailed information for a specific file by ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a file

Deletes a file by ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get a list of files

Retrieves a paginated list of files.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Upload a file and create a call with it

Creates a temporary file and initiates a call with the temporary file.

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"owner_id": "string",
"reference_type": "",
"reference_id": "string",
"name": "string",
"detail": "string",
"filename": "string",
"filesize": 0,
"uri_download": "string",
"tm_download_expire": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Tag

Operations related to tag

Find more about tag

Get the tag

Retrieves the tag details by its ID.

path Parameters

id

required

string

The ID of the tag.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete the tag

Deletes the tag identified by the given ID.

path Parameters

id

required

string

The ID of the tag to be deleted.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update the tag info

Updates the tag's name and detail information.

path Parameters

id

required

string

The ID of the tag.

Request Body schema: application/json

name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Create a new tag.

Creates a new tag with the specified information.

Request Body schema: application/json

name required	string
detail required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

List tags

Retrieves a list of tags for the customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"name": "string",
"detail": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Transcribe

Operations related to transcribe

Find more about transcribe

Stop an ongoing transcription

Stops an ongoing transcription for the specified ID and returns the result.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "unknown",
"reference_id": "string",
"status": "progressing",
"language": "string",
"direction": "both",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get detailed transcribe info

Retrieves detailed information about a specific transcription by ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "unknown",
"reference_id": "string",
"status": "progressing",
"language": "string",
"direction": "both",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a transcribe

Deletes a transcription by ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "unknown",
"reference_id": "string",
"status": "progressing",
"language": "string",
"direction": "both",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Get list of transcribes

Retrieves a paginated list of transcriptions for the authenticated customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"reference_type": "unknown",
"reference_id": "string",
"status": "progressing",
"language": "string",
"direction": "both",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a transcribe

Creates a transcription of a recording and returns the result.

Request Body schema: application/json
required

reference_type required	string (TranscribeManagerTranscribeReferenceType) Enum: "unknown" "recording" "call" "confbridge"
reference_id required	string The ID of the reference for the transcription.
language required	string The language of the transcription.
direction required	string (TranscribeManagerTranscribeDirection) Enum: "both" "in" "out"

Responses

Request samples

Payload

Content type

application/json

{"reference_type": "unknown",
"reference_id": "string",
"language": "string",
"direction": "both"
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"reference_type": "unknown",
"reference_id": "string",
"status": "progressing",
"language": "string",
"direction": "both",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of transcripts

Fetch a list of transcripts associated with the customer.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create
transcribe_id required	string

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"transcribe_id": "string",
"direction": "both",
"message": "string",
"tm_transcript": "string",
"tm_create": "string"
}
]
}

Transfer

Operations related to transfer

Find more about transfer

Start a transfer

Initiates a call transfer and returns the result.

Request Body schema: application/json
required

transfer_type required	string (TransferManagerTransferType) Enum: "attended" "blind"
transferer_call_id required	string Call ID of the transfer initiator.
required	Array of objects (CommonAddress) Addresses of the transfer recipients.

Responses

Request samples

Payload

Content type

application/json

{"transfer_type": "attended",
"transferer_call_id": "string",
"transferee_addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "attended",
"transferer_call_id": "string",
"transferee_addresses": [{"type": "",
"target": "string",
"target_name": "string",
"name": "string",
"detail": "string"
}
],
"transferee_call_id": "string",
"groupcall_id": "string",
"confbridge_id": "string",
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Trunk

Operations related to trunk

Find more about trunk

Retrieve trunk details.

Retrieves the details of a specific trunk by its ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"domain_name": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Update a trunk.

Updates the details of an existing trunk and returns the updated trunk's information.

path Parameters

id

required

string

Request Body schema: application/json
required

name required	string
detail required	string
auth_types required	Array of strings (RegistrarManagerAuthType) Items Enum: "basic" "ip"
username required	string
password required	string
allowed_ips required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"domain_name": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Delete a trunk.

Deletes an existing trunk by its ID.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"domain_name": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Retrieve a list of trunks.

Retrieves a paginated list of trunks.

query Parameters

page_size	integer The size of results.
page_token	string The token. tm_create

Responses

Response samples

200

Content type

application/json

{"next_page_token": "string",
"result": [{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"domain_name": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}
]
}

Create a new trunk.

Creates a new trunk with the provided details and returns the created trunk's information.

Request Body schema: application/json
required

name required	string
detail required	string
domain_name required	string
auth_types required	Array of strings (RegistrarManagerAuthType) Items Enum: "basic" "ip"
username required	string
password required	string
allowed_ips required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"detail": "string",
"domain_name": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"customer_id": "string",
"name": "string",
"detail": "string",
"domain_name": "string",
"auth_types": ["basic"
],
"username": "string",
"password": "string",
"allowed_ips": ["string"
],
"tm_create": "string",
"tm_update": "string",
"tm_delete": "string"
}

Websocket

Operations related to websocket

Find more about websocket

Create a new websocket connection.

Establishes a new websocket connection for real-time communication.

VoipBin API (1.0.0)

Accesskey

Get list of accesskeys

query Parameters

Responses

Response samples

Create a new accesskey.

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get details of an accesskey

path Parameters

Responses

Response samples

Delete an accesskey

path Parameters

Responses

Update an accesskey

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Activeflow

Create a new activeflow

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List all activeflows

query Parameters

Responses

Response samples

Delete an activeflow

path Parameters

Responses

Get an activeflow by ID

path Parameters

Responses

Response samples

Stop an activeflow

path Parameters

Responses

Response samples

Agent

List agents

query Parameters

Responses

Response samples

Create a new agent

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get the agent

path Parameters

Responses

Response samples

Delete the agent

path Parameters

Responses

Response samples

Update an agent

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update an agent's addresses

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update an agent's tag IDs

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required