Call Actions

APIs for Call Actions

Stop a Call

POST https://{subdomain}.oncaller.asia/api/v1/call/stop-a-call

This endpoint allows you to stop a on going call

Headers

Name	Type	Description
Authentication	string	Bearer + {token}

Request Body

Name	Type	Description
callId	string	Call ID

200 Cake successfully retrieved.

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": null
}

Transfer a Call

POST https://{subdomain}.oncaller.asia/api/v1/call/transfer

Headers

Name	Type	Description
Accept	string	application/json
Authentication	string	Bearer + {token}

Request Body

Name	Type	Description
callId	string	Call ID
fromUserId	string	Transfer from this User Id
to.type	string	internal/external
to.number	string	User ID or phone number

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": null
}

Advance Call Transfer

POST https://{subdomain}.oncaller.asia/api/v1/call/transfer/advance

With advance mode, you can set type of transfer.

Headers

Name	Type	Description
Authentication	string	Bearer + {token}
Accept	string	application/json

Request Body

Name	Type	Description
callId	string	Call Id
to.type	string	internal/external/queue
to.number	string	User Id/ Phone number/ Queue ID
to.alias	string	Name of to number
transferType	string	blind/ attendend

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": null
}

Add participant to the exist call

POST https://{subdomain}.oncaller.asia/api/v1/call/add-user

You can add a participant to the exist call

Headers

Name	Type	Description
Authentication	string	Bearer + {token}
Accept	string	application/json

Request Body

Name	Type	Description
callId	string	Call Id
from.type	string	external/ internal
from.number	string	From Number
from.alias	string	From number alias
to.type	string	external/ internal
to.number	string	To number/ User Id
to.alias	string	To number alias
spyCall	boolean	true/ false. If is true, new user added to call can not talk.

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": null
}

Make Call Out

POST https://{subdomain}.oncaller.asia/api/v1/call/call-out

Make a call out and do something: talk, play...

Headers

Name	Type	Description
Authentication	string	Bearer + {token}
Accept	string	application/json

Request Body

Name	Type	Description
from.type	string	internal
from.number	string	From hotline number
from.alias	string	Name of hotline number
to.type	string	external/ internal
to.number	string	To number of customer
to.alias	string	Name of to number
answer_url	string	Required unless actions not exist
actions.*.action	string	Required unless answer url not exist
actions.*.text	string	Text of auto Text to Speech
actions.*.voice	string	Type of voice: female, male, hatieumai, ngoclam, banmai, leminh, myan, lannhi, sg_male_xuankien_vdts_48k-hsmm, sg_female_xuanhong_vdts_48k-hsmm, hn_male_xuantin_vdts_48k-hsmm, hn_female_thutrang_phrase_48k-hsmm
actions.*.speed	number	Play speed. Default 0
actions.*.loop	string	Number of replay. Default 3

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": null
}