RobotCall
Initiates an outbound call from an intelligent contact robot.
Operation description
-
Before initiating an outbound call from an intelligent contact robot, make sure that you have an approved script on the Script Management page and an approved real number on the Real Number Management page of the voice messaging service.
-
You can obtain the creation time of the call from the date parameter in the Response Header after calling this operation.
For example, if the date parameter is "date": "Mon, 24 Jun 2024 03:40:31 GMT", the creation time of the call is "2024-06-24 03:40:31".
QPS limit
Per-user call frequency: not throttled.
API frequency: 1,000 calls per second.
If the total calls from multiple users exceed the API frequency, throttling is also triggered.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CalledShowNumber |
string |
Yes |
The caller number for the outbound call. You can view this number on the Real Number Management page of the voice messaging service. |
132****0849 |
| CalledNumber |
string |
Yes |
The called number. |
131****2204 |
| RobotId |
integer |
Yes |
The robot ID, which is the script ID. You can view approved script IDs on the Script Management page. |
1000035****** |
| OutId |
string |
No |
The ID reserved for the caller. This ID is returned to the caller through a receipt message. The value is 1 to 15 bytes in length. |
222356**** |
| RecordFlag |
boolean |
No |
Specifies whether to record the call. Valid values:
|
true |
| EarlyMediaAsr |
boolean |
No |
Specifies whether to enable the number status identification feature. Valid values:
Note
After this feature is enabled, the reason why a call is not answered is recorded. |
false |
| Params |
string |
No |
The parameter list of the robot in JSON format. The total length cannot exceed 512 bytes. You can view the parameters on the Script Management > Details > Input/Output Parameters page or by calling the ListRobotParams operation. |
{ "name": "Zhang San", "age": "25" } |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Code |
string |
The request status code. OK indicates that the request was successful. |
OK |
| Data |
string |
The unique receipt ID of this call, which is the unique call ID. |
1160128*****^10281427***** |
| Message |
string |
The description of the status code. |
OK |
| RequestId |
string |
The request ID. |
A90E4451-FED7-49D2-87C8-00700A8C4D0D |
Examples
Success response
JSON format
{
"Code": "OK",
"Data": "1160128*****^10281427*****",
"Message": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Permission.NotAuthorized | Insufficient permissions. Please contact the primary account administrator. | |
| 400 | Parameter.Error | Parameter error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.