{ "opencollection": "1.0.0", "info": { "name": "Infobip OpenAPI Specification", "version": "3.210.0" }, "items": [ { "info": { "name": "channels", "type": "folder" }, "items": [ { "info": { "name": "Get calls configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/configurations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calls configurations." }, { "info": { "name": "Create calls configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/configurations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create calls configuration." }, { "info": { "name": "Get calls configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/configurations/:callsConfigurationId", "params": [ { "name": "callsConfigurationId", "value": "", "type": "path", "description": "Calls configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single calls configuration." }, { "info": { "name": "Update calls configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/configurations/:callsConfigurationId", "params": [ { "name": "callsConfigurationId", "value": "", "type": "path", "description": "Calls configuration ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update calls configuration." }, { "info": { "name": "Delete calls configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/configurations/:callsConfigurationId", "params": [ { "name": "callsConfigurationId", "value": "", "type": "path", "description": "Calls configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete calls configuration." }, { "info": { "name": "Get calls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls", "params": [ { "name": "type", "value": "PHONE", "type": "query", "description": "Call endpoint type." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "from", "value": "44790123456", "type": "query", "description": "Caller identifier." }, { "name": "to", "value": "44790987654", "type": "query", "description": "Callee identifier." }, { "name": "direction", "value": "OUTBOUND", "type": "query", "description": "Call direction." }, { "name": "status", "value": "FINISHED", "type": "query", "description": "Call state." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "conferenceId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Conference ID." }, { "name": "dialogId", "value": "6c73cbdc-c956-4bf5-a026-318236559167", "type": "query", "description": "Dialog ID." }, { "name": "bulkId", "value": "bde6deaa-23af-4340-aac7-f3fa063c4215", "type": "query", "description": "Bulk ID." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calls with pagination." }, { "info": { "name": "Create call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an outbound call to a given endpoint." }, { "info": { "name": "Get call", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls/:callId", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single call." }, { "info": { "name": "Get calls history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls/history", "params": [ { "name": "type", "value": "PHONE", "type": "query", "description": "Call endpoint type." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "from", "value": "44790123456", "type": "query", "description": "Caller identifier." }, { "name": "to", "value": "44790987654", "type": "query", "description": "Callee identifier." }, { "name": "direction", "value": "OUTBOUND", "type": "query", "description": "Call direction." }, { "name": "status", "value": "FINISHED", "type": "query", "description": "Call state." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "conferenceId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Conference ID." }, { "name": "dialogId", "value": "6c73cbdc-c956-4bf5-a026-318236559167", "type": "query", "description": "Dialog ID." }, { "name": "bulkId", "value": "bde6deaa-23af-4340-aac7-f3fa063c4215", "type": "query", "description": "Bulk ID." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calls history with pagination. Calls history retention period is 5 days." }, { "info": { "name": "Get call history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls/:callId/history", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single call history. Call history retention period is 5 days." }, { "info": { "name": "Connect calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/connect", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Connect calls in a conference." }, { "info": { "name": "Connect with new call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/connect", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Connect an existing call with a new call in a conference." }, { "info": { "name": "Send ringing", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/send-ringing", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send SIP ringtone to an unanswered inbound call." }, { "info": { "name": "Pre-answer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/pre-answer", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Pre-answer a call to handle early media." }, { "info": { "name": "Answer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/answer", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Answer a call." }, { "info": { "name": "Hangup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/hangup", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Hang up a call." }, { "info": { "name": "Play file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/play", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Play an audio file on a call." }, { "info": { "name": "Stop playing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-play", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop playing an audio file on a call." }, { "info": { "name": "Say text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/say", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Say text on a call." }, { "info": { "name": "Send DTMF", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/send-dtmf", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a DTMF on a call." }, { "info": { "name": "Capture DTMF", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/capture/dtmf", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Capture a DTMF on a call." }, { "info": { "name": "Capture Speech", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/capture/speech", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Capture speech on a call." }, { "info": { "name": "Start transcription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/start-transcription", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start call transcription." }, { "info": { "name": "Stop transcription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-transcription", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop call transcription." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/start-recording", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start a recording on a call." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-recording", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop a recording on a call." }, { "info": { "name": "Start streaming media", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/start-media-stream", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start streaming media." }, { "info": { "name": "Stop streaming media", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-media-stream", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop streaming media." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/send-message", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a message to a specific WebRTC call leg." }, { "info": { "name": "Request application transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/application-transfer", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Request application transfer." }, { "info": { "name": "Accept application transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/application-transfer/:transferId/accept", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "transferId", "value": "", "type": "path", "description": "The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Accept application transfer." }, { "info": { "name": "Reject application transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/application-transfer/:transferId/reject", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "transferId", "value": "", "type": "path", "description": "The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reject application transfer." }, { "info": { "name": "Get conferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences", "params": [ { "name": "name", "value": "Conference", "type": "query", "description": "Conference name." }, { "name": "callId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Call ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get conferences with pagination." }, { "info": { "name": "Create conference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a conference." }, { "info": { "name": "Get conference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single conference." }, { "info": { "name": "Update all calls", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update all calls in a conference." }, { "info": { "name": "Get conferences history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences/history", "params": [ { "name": "name", "value": "Conference", "type": "query", "description": "Conference name." }, { "name": "callId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Call ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "endTimeBefore", "value": "2022-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get conferences history with pagination. Conferences history retention period is 5 days." }, { "info": { "name": "Get conference history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/history", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single conference history. Conference history retention period is 5 days." }, { "info": { "name": "Add new call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new outbound call and add it to a conference." }, { "info": { "name": "Add existing call", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call/:callId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add an existing call to a conference." }, { "info": { "name": "Update call", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call/:callId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a call in a conference." }, { "info": { "name": "Remove call", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call/:callId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove a call from a conference. The call stays active after this action." }, { "info": { "name": "Hangup conference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/hangup", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Hang up a conference. This action also hangs up all calls in the conference." }, { "info": { "name": "Play file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/play", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Play an audio file on a conference." }, { "info": { "name": "Stop playing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/stop-play", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop playing an audio file on a conference." }, { "info": { "name": "Say text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/say", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Say text on a conference." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/start-recording", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start recording a conference." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/stop-recording", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop recording a conference." }, { "info": { "name": "Broadcast text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/broadcast-webrtc-text", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Broadcasts a text message to conference WebRTC participants with open data channel." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/send-message", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a message to all WebRTC participants in a conference." }, { "info": { "name": "Get dialogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs", "params": [ { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "state", "value": "ESTABLISHED", "type": "query", "description": "Dialog state." }, { "name": "parentCallId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Parent call ID." }, { "name": "childCallId", "value": "072675c6-3db6-0fb9-b632-031264d09ck2", "type": "query", "description": "Child call ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get dialogs with pagination." }, { "info": { "name": "Create dialog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a dialog." }, { "info": { "name": "Create dialog with existing calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/parent-call/:parentCallId/child-call/:childCallId", "params": [ { "name": "parentCallId", "value": "126f327b-dd4e-456d-8a10-1cb78a23bc8a", "type": "path", "description": "Call ID of the parent call to be connected in a dialog." }, { "name": "childCallId", "value": "034e622a-cc7e-456d-8a10-0ba43b11aa5e", "type": "path", "description": "Call ID of the child call to be connected in a dialog. Needs to have been created using [create method](#create-call) with `parentCallId` parameter equal to the parent call ID above." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a dialog with existing calls." }, { "info": { "name": "Get dialog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId", "params": [ { "name": "dialogId", "value": "034e622a-cc7e-456d-8a10-0ba43b11aa5e", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single dialog." }, { "info": { "name": "Get dialogs history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs/history", "params": [ { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "state", "value": "ESTABLISHED", "type": "query", "description": "Dialog state." }, { "name": "parentCallId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Parent call ID." }, { "name": "childCallId", "value": "072675c6-3db6-0fb9-b632-031264d09ck2", "type": "query", "description": "Child call ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "endTimeBefore", "value": "2022-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time for when the dialog has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get dialogs history with pagination. Dialogs history retention period is 5 days." }, { "info": { "name": "Get dialog history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/history", "params": [ { "name": "dialogId", "value": "034e622a-cc7e-456d-8a10-0ba43b11aa5e", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single dialog history. Dialog history retention period is 5 days." }, { "info": { "name": "Hangup dialog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/hangup", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Hang up a dialog. This action also hangs up all calls in the dialog." }, { "info": { "name": "Play file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/play", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Play an audio file on a dialog." }, { "info": { "name": "Say text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/say", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Say text on a dialog." }, { "info": { "name": "Stop playing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/stop-play", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop playing an audio file on a dialog." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/start-recording", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start recording a dialog." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/stop-recording", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop recording a dialog." }, { "info": { "name": "Broadcast text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/broadcast-webrtc-text", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Broadcasts a text message to dialog WebRTC call legs with open data channel." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/send-message", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a message to all WebRTC call legs in a dialog." }, { "info": { "name": "Dialog transfer accept", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/transfer/accept", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Accepts a dialog transfer request." }, { "info": { "name": "Dialog transfer reject", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/transfer/reject", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Rejects a dialog transfer request." }, { "info": { "name": "Get SIP trunks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks", "params": [ { "name": "name", "value": "My SIP trunk", "type": "query", "description": "SIP trunk name." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SIP trunks with pagination." }, { "info": { "name": "Create SIP trunk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a SIP trunk. Fields not sent in request body will take default values. This operation is asynchronous. The SIP trunk will be created in the background." }, { "info": { "name": "Get SIP trunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single SIP trunk." }, { "info": { "name": "Update SIP trunk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "Sip Trunk ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a SIP trunk. Fields not sent in request body will take default values and overwrite the existing ones. This operation is asynchronous. The SIP trunk will be updated in the background." }, { "info": { "name": "Delete SIP trunk", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a SIP trunk. This operation is asynchronous. The SIP trunk will be deleted in the background." }, { "info": { "name": "Reset SIP trunk credentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId/reset-password", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reset credentials. For `REGISTERED` SIP trunks, resets the registration password. For `AUTHENTICATED` SIP trunks, resets the authentication secrets (header value and digest credentials)." }, { "info": { "name": "Get SIP trunk status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId/status", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "Sip Trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a SIP trunk status. Successfully deleted SIP trunk does not have status." }, { "info": { "name": "Set SIP trunk status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId/status", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "Sip Trunk ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Set a SIP trunk's status." }, { "info": { "name": "Get SIP trunk service addresses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SIP trunk service addresses." }, { "info": { "name": "Create SIP trunk service address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a SIP trunk service address." }, { "info": { "name": "Get SIP trunk service address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/:sipTrunkServiceAddressId", "params": [ { "name": "sipTrunkServiceAddressId", "value": "", "type": "path", "description": "SIP trunk service address ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SIP trunk service address." }, { "info": { "name": "Update SIP trunk service address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/:sipTrunkServiceAddressId", "params": [ { "name": "sipTrunkServiceAddressId", "value": "", "type": "path", "description": "SIP trunk service address ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update SIP trunk service address." }, { "info": { "name": "Delete SIP trunk service address", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/:sipTrunkServiceAddressId", "params": [ { "name": "sipTrunkServiceAddressId", "value": "", "type": "path", "description": "SIP trunk service address ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete SIP trunk service address." }, { "info": { "name": "Get countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/countries", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get countries with shortcodes you'd need for a SIP trunk address." }, { "info": { "name": "Get regions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/countries/regions", "params": [ { "name": "countryCode", "value": "HRV", "type": "query", "description": "Country code." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get regions with shortcodes you'd need for a SIP trunk address." }, { "info": { "name": "Get files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/files", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get files with pagination. Maximum number of pages is 100." }, { "info": { "name": "Upload audio file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/files", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload an audio file. Uploaded files can be played on calls, dialogs or conferences. The file will be removed if it is not used for 90 days." }, { "info": { "name": "Get file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single file." }, { "info": { "name": "Delete file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a file." }, { "info": { "name": "Get calls recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/calls", "params": [ { "name": "callId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Call ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "entityId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Entity ID." }, { "name": "endpointIdentifier", "value": "44790123456", "type": "query", "description": "Endpoint identifier." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.134+0000", "type": "query", "description": "Date and time when the (first) call recording started." }, { "name": "endTimeBefore", "value": "2022-05-01T14:35:45.154+0000", "type": "query", "description": "Date and time when the (last) call recording ended." }, { "name": "direction", "value": "OUTBOUND", "type": "query", "description": "Call direction." }, { "name": "endpointType", "value": "WEBRTC", "type": "query", "description": "Endpoint type." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings of calls with pagination." }, { "info": { "name": "Get call recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/calls/:callId", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings for a single call." }, { "info": { "name": "Delete call recordings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/calls/:callId", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete the recordings for a single call." }, { "info": { "name": "Get conferences recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/conferences", "params": [ { "name": "conferenceId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Conference ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "entityId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Entity ID." }, { "name": "conferenceName", "value": "Conference", "type": "query", "description": "Conference name." }, { "name": "callId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Filter all conference recordings where call ID was included in the recording." }, { "name": "callEndpointType", "value": "WEBRTC", "type": "query", "description": "Filter all conference recordings where calls with endpoint type were included in the recording." }, { "name": "callEndpointIdentifier", "value": "44790123456", "type": "query", "description": "Filter all conference recordings where calls with endpoint identifier were included in the recording." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.134+0000", "type": "query", "description": "Date and time when the (first) conference recording started." }, { "name": "endTimeBefore", "value": "2022-05-01T14:35:45.154+0000", "type": "query", "description": "Date and time when the (last) conference recording ended." }, { "name": "composition", "value": "true", "type": "query", "description": "Flag indicating whether auto-compose feature was turned on for the recording." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings of conferences with pagination." }, { "info": { "name": "Get conference recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings for a single conference." }, { "info": { "name": "Delete conference recordings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete the recordings for a single conference." }, { "info": { "name": "Compose conference recording on calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/recordings/conferences/:conferenceId/compose", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Compose conference recording on calls. All calls will be merged into a single audio or video file." }, { "info": { "name": "Get dialogs recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/dialogs", "params": [ { "name": "dialogId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Dialog ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "entityId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Entity ID." }, { "name": "callId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Filter all dialog recordings where call ID was included in the recording." }, { "name": "callEndpointType", "value": "WEBRTC", "type": "query", "description": "Filter all dialog recordings where calls with endpoint type were included in the recording." }, { "name": "callEndpointIdentifier", "value": "44790123456", "type": "query", "description": "Filter all dialog recordings where calls with endpoint identifier were included in the recording." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.134+0000", "type": "query", "description": "Date and time when the (first) dialog recording started." }, { "name": "endTimeBefore", "value": "2022-05-01T14:35:45.154+0000", "type": "query", "description": "Date and time when the (last) dialog recording ended." }, { "name": "composition", "value": "true", "type": "query", "description": "Flag indicating whether auto-compose feature was turned on for the recording." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings of dialogs with pagination." }, { "info": { "name": "Get dialog recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/dialogs/:dialogId", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings for a single dialog." }, { "info": { "name": "Delete dialog recordings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/dialogs/:dialogId", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete the recordings for a single dialog." }, { "info": { "name": "Compose dialog recording on calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/recordings/dialogs/:dialogId/compose", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Compose dialog recording on calls. Both calls will be merged into a single audio or video file." }, { "info": { "name": "Download recording file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/files/:fileId", "headers": [ { "name": "Range", "value": "bytes=0-1023" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download a recording file." }, { "info": { "name": "Delete recording file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a single file from a call or conference recording. The call or conference recording metadata will still exist after deleting the file, but the file will not show up anymore in the file list of that call or conference recording." }, { "info": { "name": "Get media-stream configs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/media-stream-configs", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get media-stream configs." }, { "info": { "name": "Create a media-stream configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/media-stream-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a media-stream configuration. For more details, see [documentation](https://www.infobip.com/docs/voice-and-video/calls#media-streaming-understanding-calls-api)." }, { "info": { "name": "Get media-stream configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/media-stream-configs/:mediaStreamConfigId", "params": [ { "name": "mediaStreamConfigId", "value": "", "type": "path", "description": "Media-stream configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single media-stream configuration." }, { "info": { "name": "Update a media-stream configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/media-stream-configs/:mediaStreamConfigId", "params": [ { "name": "mediaStreamConfigId", "value": "", "type": "path", "description": "Media-stream configuration ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a media-stream configuration." }, { "info": { "name": "Delete a media-stream configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/media-stream-configs/:mediaStreamConfigId", "params": [ { "name": "mediaStreamConfigId", "value": "", "type": "path", "description": "Media-stream configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a media-stream configuration." }, { "info": { "name": "Create bulk of calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a bulk of outbound calls. Currently, only `PHONE` endpoints are supported.\nWhen retry options are specified, bulk calls are retried if they meet internal or client retry criteria.\nClient retry criteria are met when call reaches the end device and fails. Internal retry criteria are met when call fails before reaching the end device." }, { "info": { "name": "Get bulk status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/bulks/:bulkId", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single bulk status. Bulk has a status if it was created with scheduling options." }, { "info": { "name": "Reschedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/reschedule", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reschedule a bulk. Rescheduling is possible only if the bulk was created with scheduling options and has not started yet." }, { "info": { "name": "Pause", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/pause", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Pause a bulk. Bulk can be paused if it is in progress and was created with scheduling options." }, { "info": { "name": "Resume", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/resume", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Resume a bulk. Bulk can be resumed if it is paused and was created with scheduling options." }, { "info": { "name": "Cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/cancel", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Cancel a bulk. Bulk can be cancelled if it was created with scheduling options and has not finished yet." }, { "info": { "name": "Create markup language call.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/markuplanguage/1/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new markup language call which will be processed according to provided markup instructions." }, { "info": { "name": "Get markup language configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markuplanguage/1/config", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get existing markup language configurations with pagination." }, { "info": { "name": "Create a markup language configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/markuplanguage/1/config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new markup language configuration." }, { "info": { "name": "Get a markup language configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markuplanguage/1/config/:configId", "params": [ { "name": "configId", "value": "123", "type": "path", "description": "Configuration identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an existing markup language configuration." }, { "info": { "name": "Update a markup language configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/markuplanguage/1/config/:configId", "params": [ { "name": "configId", "value": "123", "type": "path", "description": "Configuration identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an already existing markup language configuration. Fields that are not sent in the request body will take default values and overwrite existing ones." }, { "info": { "name": "Delete a markup language configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/markuplanguage/1/config/:configId", "params": [ { "name": "configId", "value": "123", "type": "path", "description": "Configuration identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an existing markup language configuration." }, { "info": { "name": "Send single voice message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tts/3/single", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send single voice message to one or more destination addresses." }, { "info": { "name": "Send multiple voice messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tts/3/multi", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send multiple voice messages to one or more destination addresses." }, { "info": { "name": "Send advanced voice message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tts/3/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send advanced voice messages to one or more destination addresses." }, { "info": { "name": "Get Voices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/voices/:language", "params": [ { "name": "language", "value": "", "type": "path", "description": "Represents the language abbreviation. (e.g. `en`). You can find the list of supported languages in corresponding section for sending voice message." }, { "name": "includeNeural", "value": "", "type": "query", "description": "Indicates whether neural voices should be included in the response.\nIf set to `false` or omitted, only standard voices will be included in the response.\nIf set to `true`, both standard and neural voices will be included in the response.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to retrieve all voices for the given language" }, { "info": { "name": "Get sent bulks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/bulks", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will return information about the scheduled time for a unique bulk message. Canceling and rescheduling are supported only when the voice message request contains at least one message and the message bulkId is unique." }, { "info": { "name": "Reschedule sent bulk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/tts/3/bulks", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to reschedule scheduled TTS bulk. Messages scheduled with the sendAt or Sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Rescheduling is only possible if the bulk status is PAUSED." }, { "info": { "name": "Get sent bulk's status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/bulks/status", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get status of scheduled TTS bulk." }, { "info": { "name": "Manage sent bulk's status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/tts/3/bulks/status", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to manage statuses of scheduled TTS bulk. Messages scheduled with the sendAt or sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Only voice messages that were not already sent can be canceled." }, { "info": { "name": "Search Voice IVR Scenarios", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/scenarios", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number you want to see. Default is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "Size of the page you want to see. Default is 50." }, { "name": "name", "value": "", "type": "query", "description": "The name to search by." }, { "name": "label", "value": "", "type": "query", "description": "The label of scenario to search by." }, { "name": "lastUsageDateSince", "value": "", "type": "query", "description": "Lower limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`." }, { "name": "lastUsageDateUntil", "value": "", "type": "query", "description": "Upper limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters." }, { "info": { "name": "Create Voice IVR Scenarios", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ivr/1/scenarios", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create a Voice IVR Scenario. The IVR scenario will be removed if not used for more than 1 year." }, { "info": { "name": "Get a Voice IVR Scenario", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Scenario identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get a Voice IVR Scenario." }, { "info": { "name": "Update Voice IVR Scenarios", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/voice/ivr/1/scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Scenario identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update a Voice IVR Scenario. Changes may take up to 10 minutes to apply." }, { "info": { "name": "Delete Voice IVR Scenarios", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/voice/ivr/1/scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Scenario identifier (for example E83E787CF2613450157ADA3476171E3F)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete a Voice IVR Scenario." }, { "info": { "name": "Launch IVR Scenario", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ivr/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to start an outbound IVR toward a multiple destinations." }, { "info": { "name": "Search Voice IVR Recorded Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/files", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number you want to see." }, { "name": "pageSize", "value": "", "type": "query", "description": "Size of the page you want to see." }, { "name": "messageId", "value": "", "type": "query", "description": "The message ID to search by." }, { "name": "number", "value": "", "type": "query", "description": "The called phone number to search by." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to search Voice IVR Recorded Audio Files." }, { "info": { "name": "Download Voice IVR Recorded File.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "File ID to download." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to download Voice IVR Recorded Audio File. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on Infobip servers for 2 months." }, { "info": { "name": "Get files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/uploads", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get files with pagination. Maximum number of pages is 100." }, { "info": { "name": "Upload file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ivr/1/uploads", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload an audio file to be played in IVR calls. The file will be removed if it is not used for 90 days. Supported formats: `.wav` and `.mp3`." }, { "info": { "name": "Send click-to-call message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ctc/1/send", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send click-to-call voice messages." }, { "info": { "name": "Get Voice Delivery Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned delivery reports. Default value is 50." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get delivery reports for sent Voice messages, outbound IVR or Click-to-call (without notifyUrl request parameter). Delivery reports are returned only once. Additional delivery report request will return an empty collection." }, { "info": { "name": "Get Voice Delivery Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned delivery reports. Default value is 50." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.\n\n\n\"We strongly advise you to update to new [delivery report method](https://www.infobip.com/docs/api/channels/voice/voice-reports-and-logs/get-voice-delivery-reports).\n" }, { "info": { "name": "Get sent Voice logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/logs", "params": [ { "name": "from", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "to", "value": "", "type": "query", "description": "Destination address of the voice message." }, { "name": "bulkId", "value": "", "type": "query", "description": "The ID which uniquely identifies the request." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Sent voice message status group. Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status." }, { "name": "sentSince", "value": "", "type": "query", "description": "Lower limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX." }, { "name": "sentUntil", "value": "", "type": "query", "description": "Upper limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX." }, { "name": "limit", "value": "", "type": "query", "description": "Maximal number of messages in the returned logs. Default value is 50." }, { "name": "mcc", "value": "", "type": "query", "description": "Mobile country code." }, { "name": "mnc", "value": "", "type": "query", "description": "Mobile network code." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get logs of sent Voice messages. Voice logs are available for the last 48 hours!" }, { "info": { "name": "Get number masking configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/masking/2/config", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get all voice number masking configurations." }, { "info": { "name": "Create number masking configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/masking/2/config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create masking configuration." }, { "info": { "name": "Get number masking configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/masking/2/config/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "Masking configuration identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get a Voice number masking configuration." }, { "info": { "name": "Update number masking configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/voice/masking/2/config/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "Masking configuration identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update a Voice number masking configuration." }, { "info": { "name": "Delete number masking configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/voice/masking/2/config/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "Masking configuration identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete a Voice number masking configuration." }, { "info": { "name": "Upload audio files", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/masking/1/upload", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows uploading audio files that can be used on Infobip Voice platform. The method accepts either a URL or an uploaded audio file in the request body. Using both or neither will cause the request to be rejected." }, { "info": { "name": "Get number masking credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/masking/2/credentials", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get Voice number masking credentials." }, { "info": { "name": "Create number masking credentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/masking/2/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create Voice number masking credentials." }, { "info": { "name": "Update number masking credentials", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/voice/masking/2/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update Voice number masking credentials." }, { "info": { "name": "Delete number masking credentials", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/voice/masking/2/credentials", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete Voice number masking credentials." }, { "info": { "name": "Get call routes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/routes", "params": [ { "name": "nameContains", "value": "", "type": "query", "description": "String contained in the name of the route, case-insensitive." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get existing call routes with pagination." }, { "info": { "name": "Create a call route", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/callrouting/1/routes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new call route." }, { "info": { "name": "Get a call route", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an existing call route." }, { "info": { "name": "Update a call route", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an already existing call route. Fields that are not sent in the request body will take default values and overwrite existing ones." }, { "info": { "name": "Set order on call route", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Set order on existing call route." }, { "info": { "name": "Delete a call route", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an existing call route." }, { "info": { "name": "Get recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/recordings", "params": [ { "name": "sortBy", "value": "START_TIME", "type": "query", "description": "Field that will be used for sorting." }, { "name": "sortDirection", "value": "DESC", "type": "query", "description": "Order in which files will be sorted based on sortBy field." }, { "name": "endpointType", "value": "PHONE", "type": "query", "description": "Endpoint type of at least one participant in the recorded call." }, { "name": "phoneNumber", "value": "41792036727", "type": "query", "description": "Phone number that was participant of the recorded call." }, { "name": "sipTrunkId", "value": "60d345fd3a799ec", "type": "query", "description": "SIP Trunk ID that was participant of the recorded call." }, { "name": "sipUsername", "value": "41793026834", "type": "query", "description": "Username on the SIP trunk that was participant of the recorded call." }, { "name": "webrtcIdentity", "value": "WebRTC_user", "type": "query", "description": "WebRTC Identity that was participant of the recorded call." }, { "name": "routeId", "value": "f8fc8aca-786d-4943-9af2-e7ec01b5e80d", "type": "query", "description": "Route ID that was used to establish the recorded call." }, { "name": "routeName", "value": "Sample Route Name", "type": "query", "description": "Route name to be used to match recordings. Name will be matched comparing it to all route names." }, { "name": "correlationId", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "query", "description": "Correlation ID to match." }, { "name": "startTimeAfter", "value": "2024-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time when the (first) call recording started." }, { "name": "startTimeBefore", "value": "2024-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time when the (last) call recording started." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows searching and filtering based on various recording data properties." }, { "info": { "name": "Delete by correlation ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/callrouting/1/recordings", "params": [ { "name": "correlationId", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "query", "description": "Correlation ID to match." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows deleting call recordings based on correlation ID." }, { "info": { "name": "Download recording file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/recordings/files/:fileId", "headers": [ { "name": "Range", "value": "bytes=0-1023" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID to match." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download a recording file." }, { "info": { "name": "Update route status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/callrouting/1/routes/:routeId/status", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update status of existing call route. " }, { "info": { "name": "Simulate route selection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/callrouting/1/routes/simulate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Simulates which route will be selected upon predefined request." } ] } ], "bundled": true }