{ "info": { "_postman_id": "060c7420-e433-4e66-91bb-d30e3005905c", "name": "Unifonic Authenticate Call Management and Status API", "description": "Handles verifications with OTP to multiple channels\n\nContact Support:\n Name: Unifonic Support\n Email: support@unifonic.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:22:33.000Z", "updatedAt": "2026-07-28T03:22:33.000Z", "lastUpdatedBy": "35240", "uid": "35240-060c7420-e433-4e66-91bb-d30e3005905c" }, "item": [ { "name": "calls", "item": [ { "name": "Creates an Outbound Call", "id": "25f1374a-35a7-4547-92fd-ee833e1499a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Content-Type", "value": "application/json;charset=utf-8" }, { "key": "Accept", "value": "application/json;charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": [\n \"\",\n \"\"\n ],\n \"callerId\": \"\",\n \"type\": \"otp\",\n \"callRecording\": \"\",\n \"expiry\": \"\",\n \"ivr\": {\n \"language\": \"\",\n \"voice\": \"\",\n \"say\": \"\",\n \"play\": \"\",\n \"loop\": \"\",\n \"responseUrl\": \"\",\n \"onEmptyResponse\": \"\",\n \"speechCollectionLanguage\": \"\",\n \"digitsLimit\": \"\",\n \"transfer\": \"\",\n \"queueName\": \"\"\n },\n \"referenceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/calls", "host": [ "{{baseUrl}}" ], "path": [ "calls" ] }, "description": "This operation creates a request to generate outbound calls to a list of recipients specified within the API payload." }, "response": [ { "id": "32b24205-6ac6-482a-9501-304ddae08028", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Content-Type", "value": "application/json;charset=utf-8" }, { "key": "Accept", "value": "application/json;charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "x-authenticate-app-id", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": [\n \"\",\n \"\"\n ],\n \"callerId\": \"\",\n \"type\": \"otp\",\n \"callRecording\": \"\",\n \"expiry\": \"\",\n \"ivr\": {\n \"language\": \"\",\n \"voice\": \"\",\n \"say\": \"\",\n \"play\": \"\",\n \"loop\": \"\",\n \"responseUrl\": \"\",\n \"onEmptyResponse\": \"\",\n \"speechCollectionLanguage\": \"\",\n \"digitsLimit\": \"\",\n \"transfer\": \"\",\n \"queueName\": \"\"\n },\n \"referenceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/calls", "host": [ "{{baseUrl}}" ], "path": [ "calls" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"callId\": \"\",\n \"status\": \"\",\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-32b24205-6ac6-482a-9501-304ddae08028" }, { "id": "908d846e-26c8-491b-ba98-4ae23125da2e", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Content-Type", "value": "application/json;charset=utf-8" }, { "key": "Accept", "value": "application/json;charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "x-authenticate-app-id", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": [\n \"\",\n \"\"\n ],\n \"callerId\": \"\",\n \"type\": \"otp\",\n \"callRecording\": \"\",\n \"expiry\": \"\",\n \"ivr\": {\n \"language\": \"\",\n \"voice\": \"\",\n \"say\": \"\",\n \"play\": \"\",\n \"loop\": \"\",\n \"responseUrl\": \"\",\n \"onEmptyResponse\": \"\",\n \"speechCollectionLanguage\": \"\",\n \"digitsLimit\": \"\",\n \"transfer\": \"\",\n \"queueName\": \"\"\n },\n \"referenceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/calls", "host": [ "{{baseUrl}}" ], "path": [ "calls" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": \"\"\n}", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-908d846e-26c8-491b-ba98-4ae23125da2e" }, { "id": "06f273ab-03ed-4dc0-b33f-2a0d32a556ed", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Content-Type", "value": "application/json;charset=utf-8" }, { "key": "Accept", "value": "application/json;charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "x-authenticate-app-id", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": [\n \"\",\n \"\"\n ],\n \"callerId\": \"\",\n \"type\": \"otp\",\n \"callRecording\": \"\",\n \"expiry\": \"\",\n \"ivr\": {\n \"language\": \"\",\n \"voice\": \"\",\n \"say\": \"\",\n \"play\": \"\",\n \"loop\": \"\",\n \"responseUrl\": \"\",\n \"onEmptyResponse\": \"\",\n \"speechCollectionLanguage\": \"\",\n \"digitsLimit\": \"\",\n \"transfer\": \"\",\n \"queueName\": \"\"\n },\n \"referenceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/calls", "host": [ "{{baseUrl}}" ], "path": [ "calls" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-06f273ab-03ed-4dc0-b33f-2a0d32a556ed" }, { "id": "51dd2b8a-a6fa-4240-8cb2-9f6d2b17a0b4", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Content-Type", "value": "application/json;charset=utf-8" }, { "key": "Accept", "value": "application/json;charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "x-authenticate-app-id", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": [\n \"\",\n \"\"\n ],\n \"callerId\": \"\",\n \"type\": \"otp\",\n \"callRecording\": \"\",\n \"expiry\": \"\",\n \"ivr\": {\n \"language\": \"\",\n \"voice\": \"\",\n \"say\": \"\",\n \"play\": \"\",\n \"loop\": \"\",\n \"responseUrl\": \"\",\n \"onEmptyResponse\": \"\",\n \"speechCollectionLanguage\": \"\",\n \"digitsLimit\": \"\",\n \"transfer\": \"\",\n \"queueName\": \"\"\n },\n \"referenceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/calls", "host": [ "{{baseUrl}}" ], "path": [ "calls" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-51dd2b8a-a6fa-4240-8cb2-9f6d2b17a0b4" } ], "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-25f1374a-35a7-4547-92fd-ee833e1499a8" } ], "id": "aab3f924-b605-421a-a9e8-46628424e0d5", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-aab3f924-b605-421a-a9e8-46628424e0d5" }, { "name": "providers", "item": [ { "name": "voice-call-log", "item": [ { "name": "{callId}", "item": [ { "name": "Retrieves call status", "id": "cdd0f7aa-d5b0-45f7-9a81-34154aa671d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Accept", "value": "application/json;charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/providers/voice-call-log/:callId", "host": [ "{{baseUrl}}" ], "path": [ "providers", "voice-call-log", ":callId" ], "variable": [ { "id": "bdf5fa34-8105-4498-a199-ddefa4ad3983", "key": "callId", "value": "", "description": "(Required) identifier of the call API request" } ] }, "description": "This operation retrieves the call status(es) of all the dials pertaining to a particular callId. A callId is provided in the API response whenever a POST/Calls API is accepted. " }, "response": [ { "id": "8e7a17c1-06a8-4ac5-afd8-342283bf4619", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) applicationId found on Unifonic Console", "key": "appsId", "value": "" }, { "key": "Accept", "value": "application/json;charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "x-authenticate-app-id", "value": "" } ], "url": { "raw": "{{baseUrl}}/providers/voice-call-log/:callId", "host": [ "{{baseUrl}}" ], "path": [ "providers", "voice-call-log", ":callId" ], "variable": [ { "key": "callId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"callId\": \"\",\n \"type\": \"otp\",\n \"retry\": \"\",\n \"callerId\": \"\",\n \"recipients\": [\n {\n \"duration\": \"\",\n \"status\": \"rejected\",\n \"number\": \"\"\n },\n {\n \"duration\": \"\",\n \"status\": \"cancelled\",\n \"number\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-8e7a17c1-06a8-4ac5-afd8-342283bf4619" } ], "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-cdd0f7aa-d5b0-45f7-9a81-34154aa671d0" } ], "id": "c83939ad-a79a-4b85-9c0d-e0ac4c599095", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-c83939ad-a79a-4b85-9c0d-e0ac4c599095" } ], "id": "20d29321-b5fe-4a0a-8816-8b11ae683499", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-20d29321-b5fe-4a0a-8816-8b11ae683499" } ], "id": "4f2a82ca-9c34-46ca-9c84-1ac912f6af9a", "createdAt": "2026-07-28T03:22:34.000Z", "updatedAt": "2026-07-28T03:22:34.000Z", "uid": "35240-4f2a82ca-9c34-46ca-9c84-1ac912f6af9a" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-authenticate-app-id", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://authenticate.cloud.api.unifonic.com" } ] }