Dialer Make Call API
Use this API to initiate a Dialer Flow request.
Before sending a request, make sure to whitelist your IP through which you are sending an API requests in the whitelist section.
API URL: https://central.phonon.in/kairos-apis/enc/outbounddialer/create
Request Parameters:
Method | POST |
|---|---|
Body | JSON |
Headers | Content-Type: application/json |
Auth | None |
Payload Schema:
{
"requestEncryptedValue": "<encryptedRequestPayload>",
"requestDigitalSignatureValue": "<encryptedAESKeyValue>",
"flow-id": "<8 character alphanumeric>",
}
Sample Payload:
{
"requestEncryptedValue": "pIisitW+w8s2Dz4NfUm3EH2RnBU/X2HctqMmgheJI/dVsyDSKDPKBbydBLsQuNTqioA2wYjENo1EyH9ZXol3NNuWtR5yhcQFHPvcJGOQw7DCHe6FfRIFaAiYyz/dYMhVICrDKhmVyAcaZkBkFkjvE9IuvaIqNDb3fWRW2faO4+IRgYkh/701mAIqMYohFWWP+JmIbah+VpaQ6SoHYR+JjHNuXmKq8KkrCJOTlCyakX/u05vmWr/h8TQmgo+XLJaygrcQf2oJFreWqarFyk4CsQV4XhCoyia0PK7r6Wb1f5qC3oofPG3dE1mYrya+96bVcBVFj0MCFQvLRUQ7LLNAkf0XfWMFNVOtoBd7iGHY7K8jvX46sQ1jA3SDpcVwMsP/OtQCK1r0oClRCBjWo6C0BIwVomstjSdGvIM4buwSgBQUIri4deAaFFmR0yOIIJyF/Ytg+h2aWnOTK0LLC6TNpHhmyWxwTd0QJnoUT4ob11BgOBqYigCnQTCWzhslcK6veeuxADmiykq/36SxIgispNigMW8nUTEhiP+b9TyKPsIl1fxMRFsVvtWKbyK78/mNWbCUic3bpOX+i6M7l+pdFg==",
"requestDigitalSignatureValue": "ClKdnVq3RBlzOiVaOU83prMrq9JfABjK+oYZcMI/Odcs+rmsxV9u8rlScdX1CQDNA2cyLSSVDLbcA0oB2MTikVTorsohjI0c9NxnxpAOw/jCQmepb6Ix9FIoJo+B3rjyxiwBR8MHLc+1cL1eNaKexx+TVgtjKZjLfu85efnkupZ65Vo80xuMqY+VE4lyKAIswMvWqvpBbhMBsbBsq5Po6GZATTf+A76Mo42k4N43V/gPdysZ8IcP6Wi1bLm+jcZuudsD1zrbPebnRxGlZZqKOBmQhe1iPxdQ3DViZEZzjEoCSWIUqhC5wwyFdmRbH3HuUdWV7qg7te9kOxy2RWnEep1vfd/60Gpvl7GrUvS1sSq20wDCELz7tKbL3YQAUgwMpwtAxDVweo+a26Ko4lcKNhMcwpCItmQqSQkByWlJCEb10edNuxtxup4LtDF/kH1mNWnwNYvnxo3OVyL9k3OBzdBqAzKO7aSEY8Hm1WZorSksEqxQ1z0OUQZFvrJFWsEH3opDGU2TS11VHgl9pg7BTDZpnXvZiIBFivB2Coa61EgBiROoVdaHBb8rF9Cy4kN8bcye3hZQh5Oq37/wJLDjEefisXpRm4qfQMtSZ6Yb/kLs3TD6+75m9LggYSXrxSmPlbrjWGY0tXBzN8hGW0xRhURuYESuDYH3L6WpG1JNZ54=",
"flow-id": "ZH0RKJvh",
}
Request Parameters Explanation:
requestEncryptedValue: Encrypted JSON request payload of the outbound flow.requestDigitalSignatureValue: Get the security ID from the ‘Edit Flow’ page of any Outbound Dailer Flowflow-id: Get the 8 character alpha numeric Flow ID from the ‘Edit Flow’ page of any Outbound Dailer Flow
Response:
Successful Response:
Status Code: 200{ "api-response-code": 200, "api-response-message": "Success", "request-id": "c46e46f4-dc58-4839-9483-f7dd9aac28a0", "call-details": [ { "client-identifier": "2021-04-28T03:48:07.110Z", "phonon-uuid": "501c78ee-8d06-498e-8952-fce3495f326b" } ] }
a. Request ID: Unique Identifier for the whole request.
b. Phonon UUID: Unique Identifier for each call.
Important Error Response:
{
"api-response-code": 500/401/201/202/301,
"api-response-message": "Failure/IP Not Whitelisted/Checksum Repeated/Invalid Security ID/Invalid Flow ID",
}
IP Not Whitelisted401 : Please whitelist your IP in the Whitelist section.Checksum Repeated201 : You can trigger the same API payload more than once. Please change at least one parameter. (Date-time, client-identifier, etc.)Invalid Security ID202 : Security ID is invalid. Please check the endpoint and security ID.Invalid Flow ID301 : Flow ID is invalid. Please check the endpoint and Flow ID.Failure500 : Any Failure scenario.
All Error Codes:
Status Code | Status Message | Status Name | |
|---|---|---|---|
| 1 | 400 | Invalid Format | INVALID_FORMAT |
| 2 | 201 | Checksum Repeated | CHECKSUM_REPEATED |
| 3 | 302 | Empty Call List | EMPTY_CALL_LIST |
| 4 | 500 | Failure | FAILURE |
| 5 | 301 | Invalid Flow ID | INVALID_FLOW_ID |
| 6 | 401 | IP Not Whitelisted | IP_NOT_WHITELISTED |
| 7 | 402 | Phone Not Whitelisted | PHONE_NOT_WHITELISTED |
| 8 | 202 | Invalid Security ID | INVALID_SECURITY_ID |
| 9 | 200 | Success | SUCCESS |
| 10 | 203 | API Version not Supported | INVALID_API_VERSION |
| 11 | 204 | Invalid SMS Gateway | INVALID_GATEWAY_ID |
| 12 | 205 | Invalid Contact Number | INVALID_CONTACT_NUMBER |
| 13 | 206 | Failure from Gateway | FAILURE_FROM_GATEWAY |
| 14 | 207 | DID Not Mapped | DID_NOT_MAPPED |
| 15 | 208 | No Mask Available | NO_MASK_AVAILABLE |
| 16 | 209 | Partial Success | PARTIAL_SUCCESS |
| 17 | 210 | Invalid Mandatory Parameters | INVALID_MANDATORY_PARAMETERS |
| 18 | 303 | Max Data List Size Exceeded | MAX_DATA_LIST_SIZE_EXCEEDED |
| 19 | 211 | Validity Expired | VALIDITY_EXPIRED |
| 20 | 212 | Insufficient Balance | INSUFFICIENT_BALANCE |
| 21 | 304 | Invalid Flow Version | INVALID_FLOW_VERSION |
| 22 | 213 | No Data Available | NO_DATA_AVAILABLE |
Other Docs:
Todo: https://docs.google.com/document/d/1A5UciLQYB6hS7VwKjazU204IxMwlfD_KwSnexlkaa8Y/edit#
Tech API Docs: /wiki/spaces/CB/pages/201752979
Todo, add Security: /wiki/spaces/CB/pages/209224413
0 Comments