{ "swagger": "2.0", "info": { "title": "Zvanu Parvaldnieks", "description": "Zvanu Parvaldnieks is a mobile virtual PBX service for LMT mobile subscribers. This connector lets users to easily send all the data and events about calls, voicemails, contacts and configuration to other services.", "version": "1.0", "contact": { "name": "Latvijas Mobilais Telefons", "url": "https://zvanuparvaldnieks.lmt.lv", "email": "tehn.atbalsts@lmt.lv" } }, "x-ms-connector-metadata": [ { "propertyName": "Website", "propertyValue": "https://zvanuparvaldnieks.lmt.lv" }, { "propertyName": "Privacy policy", "propertyValue": "https://www.lmt.lv/en/data-processing" }, { "propertyName": "Categories", "propertyValue": "Communication;IT Operations" } ], "host": "zvanuparvaldnieks.lmt.lv", "basePath": "/api/v2/", "schemes": [ "https" ], "consumes": [], "produces": [], "paths": { "/webhooks": { "x-ms-notification-content": { "description": "Provides event with data payload about the call when event CallstartedEvent is received during the start of the call.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" } }, "description": "data" } } } } }, "/contacts/{contact_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "current_callerid": { "type": "string", "description": "current_callerid" }, "archived": { "type": "integer", "format": "int32", "description": "archived" }, "firstname": { "type": "string", "description": "firstname" }, "lastname": { "type": "string", "description": "lastname" }, "created": { "type": "string", "description": "created" }, "number": { "type": "string", "description": "number" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "group_membership": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "string", "description": "created" }, "groupID": { "type": "integer", "format": "int32", "description": "groupID" }, "type": { "type": "integer", "format": "int32", "description": "type" }, "name": { "type": "string", "description": "name" }, "members": { "type": "array", "items": { "type": "object", "properties": { "contactID": { "type": "integer", "format": "int32", "description": "contactID" } } }, "description": "members" } } }, "description": "group_membership" }, "avatar": { "type": "string", "description": "avatar" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Contacts by ID", "description": "Retrieve a single employee object by providing an ID.", "operationId": "GetContactsByID", "x-ms-visibility": "important", "parameters": [ { "name": "contact_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the employee.", "x-ms-summary": "Contact ID", "x-ms-url-encoding": "single" } ] } }, "/groups/{group_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "created": { "type": "string", "description": "created", "title": "Created", "format": "date-time" }, "groupID": { "type": "integer", "format": "int32", "description": "groupID" }, "type": { "type": "integer", "format": "int32", "description": "type" }, "name": { "type": "string", "description": "name" }, "members": { "type": "array", "items": { "type": "object", "properties": { "contactID": { "type": "integer", "format": "int32", "description": "contactID" } } }, "description": "members" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Group By ID", "description": "Retrieve a single employee group object by providing an ID.", "operationId": "GetGroupByID", "x-ms-visibility": "important", "parameters": [ { "name": "group_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the employee group.", "x-ms-summary": "Group ID", "x-ms-url-encoding": "single" } ] } }, "/call_records/{record_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "recordingID": { "type": "integer", "format": "int32", "description": "recordingID" }, "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "callEnded": { "type": "string", "description": "callEnded" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "recordingURL": { "type": "string", "description": "recordingURL" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Call Recording by ID", "description": "Retrieve a single call recording by providing an ID.", "operationId": "GetCallRecordingByID", "x-ms-visibility": "important", "parameters": [ { "name": "record_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the recording.", "x-ms-summary": "Record ID", "x-ms-url-encoding": "single" } ] } }, "/trigger/call_records": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "recordingID": { "type": "integer", "format": "int32", "description": "recordingID" }, "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "callEnded": { "type": "string", "description": "callEnded" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "recordingURL": { "type": "string", "description": "recordingURL" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Call Recordings", "description": "Retrieve Call recordings. Additionally API consumer may filter the returned records based on a specific number or employee involved in the call (source, destination, or contact_id), as well as direction to filter out only incoming or outgoing calls or only calls made within a specified date range (date_range).", "operationId": "GetCallRecordings", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "record_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the recording.", "x-ms-visibility": "important", "x-ms-summary": "Record ID" }, { "name": "initial_record_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial record ID for querying only newly created records.", "x-ms-summary": "Initial record ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" }, { "name": "destination", "in": "query", "required": false, "type": "string", "description": "The number which call was placed to.", "x-ms-visibility": "important", "x-ms-summary": "Destination number" }, { "name": "source", "in": "query", "required": false, "type": "string", "description": "The number of calling party.", "x-ms-visibility": "important", "x-ms-summary": "Source number" }, { "name": "direction", "in": "query", "required": false, "type": "string", "description": "\"in\" or \"out\" to indicate if the call was incoming or outgoing.", "x-ms-visibility": "important", "x-ms-summary": "Direction" }, { "name": "contact_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the Employee involved in the call.", "x-ms-visibility": "important", "x-ms-summary": "Contact ID" }, { "name": "date_from", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Starting date in the filtered date range.", "x-ms-visibility": "important", "x-ms-summary": "Date from" }, { "name": "date_to", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "End date in the filtered date range.", "x-ms-summary": "Date to" } ], "x-ms-trigger-hint": "Triggers when a new call recording is created", "x-ms-visibility": "important" } }, "/trigger/call_history": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "callEnded": { "type": "string", "description": "callEnded" }, "connectionTime": { "type": "integer", "format": "int32", "description": "connectionTime" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "recordingID": { "type": "integer", "format": "int32", "description": "recordingID" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get call History", "description": "Retrieve Call history entries. Additionally API consumer may filter the returned records based on a specific number or employee involved in the call (source, destination, or contact_id), as well as direction to filter out only incoming or outgoing calls or only calls made within a specified date range (date_range).", "operationId": "GetCallHistory", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "call_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the call.", "x-ms-summary": "Call ID" }, { "name": "initial_call_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial call ID for querying only newly created calls.", "x-ms-summary": "Initial call ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" }, { "name": "destination", "in": "query", "required": false, "type": "string", "description": "The number which call was placed to.", "x-ms-visibility": "important", "x-ms-summary": "Destination number" }, { "name": "source", "in": "query", "required": false, "type": "string", "description": "The number of calling party.", "x-ms-visibility": "important", "x-ms-summary": "Source number" }, { "name": "direction", "in": "query", "required": false, "type": "string", "description": "\"in\" or \"out\" to indicate if the call was incoming or outgoing.", "x-ms-visibility": "important", "x-ms-summary": "Direction" }, { "name": "contact_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the Employee involved in the call.", "x-ms-summary": "Contact ID" }, { "name": "date_from", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Starting date in the filtered date range.", "x-ms-visibility": "important", "x-ms-summary": "Date from" }, { "name": "date_to", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "End date in the filtered date range.", "x-ms-summary": "Date to" } ], "x-ms-trigger-hint": "Triggers when a new call is registered.", "x-ms-visibility": "important" } }, "/trigger/voicemail_boxes": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "clientID": { "type": "integer", "format": "int32", "description": "clientID" }, "boxName": { "type": "string", "description": "boxName" }, "created": { "type": "string", "description": "created" }, "voicemailBoxID": { "type": "integer", "format": "int32", "description": "voicemailBoxID" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Voicemail Boxes", "description": "Retrieve a list of created voicemail boxes.", "operationId": "GetVoicemailBoxes", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "box_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the voicemail box.", "x-ms-visibility": "important", "x-ms-summary": "Voicemail box ID" }, { "name": "initial_box_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial voicemail box ID for querying only newly created voicemail boxes.", "x-ms-summary": "Initial voicemail box ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" } ], "x-ms-trigger-hint": "Triggers when a new voicemail box is created", "x-ms-visibility": "important" } }, "/trigger/voicemails": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "sender": { "type": "string", "description": "sender" }, "voicemailID": { "type": "integer", "format": "int32", "description": "voicemailID" }, "length": { "type": "integer", "format": "int32", "description": "length" }, "callStarted": { "type": "string", "description": "callStarted" }, "voicemailBoxID": { "type": "integer", "format": "int32", "description": "voicemailBoxID" }, "voicemailBoxName": { "type": "string", "description": "voicemailBoxName" }, "messageURL": { "type": "string", "description": "messageURL" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get voicemails", "description": "Retrieve Voicemail messages. Additionally API consumer may filter the returned records based on contact_id, source, box_id, or date_range to limit the result to only those messages that are left for a specific employee, voicemail box, from a specific number, or within a requested date range.", "operationId": "GetVoicemails", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "voicemail_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the voicemail message.", "x-ms-visibility": "important", "x-ms-summary": "Voicemail ID" }, { "name": "initial_voicemail_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial voicemail ID for querying only newly created voicemails.", "x-ms-summary": "Initial voicemail ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" }, { "name": "source", "in": "query", "required": false, "type": "string", "description": "The number of calling party.", "x-ms-visibility": "important", "x-ms-summary": "Source number" }, { "name": "contact_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the Employee.", "x-ms-summary": "Contact ID" }, { "name": "box_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the voicemail box.", "x-ms-summary": "Voicemail box ID" }, { "name": "date_from", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Starting date in the filtered date range.", "x-ms-visibility": "important", "x-ms-summary": "Date from" }, { "name": "date_to", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "End date in the filtered date range.", "x-ms-summary": "Date to" } ], "x-ms-trigger-hint": "Checks for new voicemail is created.", "x-ms-visibility": "important" } }, "/trigger/audio_prompts": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "id" }, "name": { "type": "string", "description": "name" }, "type": { "type": "integer", "format": "int32", "description": "type" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Retrieve audio prompt entries.", "summary": "Get Audio Prompts", "operationId": "GetAudioPrompts", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "prompt_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the audio prompt.", "x-ms-visibility": "important", "x-ms-summary": "Audio prompt ID" }, { "name": "initial_prompt_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial audio prompt ID for querying only newly created audio prompts.", "x-ms-summary": "Initial audio prompt ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" } ], "x-ms-trigger-hint": "Triggers when a new audio prompt is created", "x-ms-visibility": "important" } }, "/trigger/voip_endpoints": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "id" }, "name": { "type": "string", "description": "name" }, "employee_id": { "type": "integer", "format": "int32", "description": "employee_id" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get VoIP Endpoints", "description": "Retrieve VoIP endpoint entries.", "operationId": "GetVoipEndpoints", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "endpoint_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the VoIP endpoint.", "x-ms-visibility": "important", "x-ms-summary": "VoIP endpoint ID" }, { "name": "initial_endpoint_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial VoIP endpoint ID for querying only newly created VoIP endpoints.", "x-ms-summary": "Initial VoIP endpoint ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" } ], "x-ms-trigger-hint": "Triggers when a new VoIP endpoint is created", "x-ms-visibility": "important" } }, "/call_history/{call_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "callEnded": { "type": "string", "description": "callEnded" }, "connectionTime": { "type": "integer", "format": "int32", "description": "connectionTime" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "recordingID": { "type": "integer", "format": "int32", "description": "recordingID" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Call History Item By ID", "operationId": "GetCallHistoryItemByID", "description": "Retrieve a single call history entry by providing an ID.", "parameters": [ { "name": "call_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the call.", "x-ms-summary": "Call ID", "x-ms-url-encoding": "single" } ], "x-ms-visibility": "important" } }, "/voicemail_boxes/{box_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "clientID": { "type": "integer", "format": "int32", "description": "clientID" }, "boxName": { "type": "string", "description": "boxName" }, "created": { "type": "string", "description": "created" }, "voicemailBoxID": { "type": "integer", "format": "int32", "description": "voicemailBoxID" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Retrieve a single voicemail box object by providing an ID.", "summary": "Get Voicemail Box By ID", "operationId": "GetVoicemailBoxByID", "parameters": [ { "name": "box_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the voicemail box.", "x-ms-summary": "Voicemail box ID", "x-ms-url-encoding": "single" } ], "x-ms-visibility": "important" } }, "/voicemails/{voicemail_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "sender": { "type": "string", "description": "sender" }, "voicemailID": { "type": "integer", "format": "int32", "description": "voicemailID" }, "length": { "type": "integer", "format": "int32", "description": "length" }, "callStarted": { "type": "string", "description": "callStarted" }, "voicemailBoxID": { "type": "integer", "format": "int32", "description": "voicemailBoxID" }, "voicemailBoxName": { "type": "string", "description": "voicemailBoxName" }, "messageURL": { "type": "string", "description": "messageURL" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Retrieve a single voicemail object by providing an ID.", "summary": "Get Voicemail By ID", "operationId": "GetVoicemailByID", "parameters": [ { "name": "voicemail_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the voicemail.", "x-ms-summary": "Voicemail ID", "x-ms-url-encoding": "single" } ], "x-ms-visibility": "important" } }, "/audio_prompts/{prompt_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "id" }, "name": { "type": "string", "description": "name" }, "type": { "type": "integer", "format": "int32", "description": "type" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Retrieve a single audio prompt object by providing an ID.", "summary": "Get Audio Prompt By ID", "operationId": "GetAudioPromptByID", "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the audio prompt.", "x-ms-summary": "Audio prompt ID", "x-ms-url-encoding": "single" } ], "x-ms-visibility": "important" } }, "/voip_endpoints/{endpoint_id}": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "id" }, "name": { "type": "string", "description": "name" }, "employee_id": { "type": "integer", "format": "int32", "description": "employee_id" } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Retrieve a single VoIP endpoint object by providing an ID.", "summary": "Get VoIP Endpoint By ID", "operationId": "GetVoipEndpointByID", "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the VoIP endpoint.", "x-ms-summary": "VoIP endpoint ID", "x-ms-url-encoding": "single" } ], "x-ms-visibility": "important" } }, "/dial": { "post": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": {}, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Dial", "description": "Request the start of new call by sending a request to a device.", "operationId": "Dial", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "destination": { "type": "string", "description": "Destination number.", "title": "Destination", "x-ms-visibility": "important" }, "contactID": { "type": "integer", "format": "int32", "description": "Unique ID of the employee", "title": "contact ID", "x-ms-visibility": "important" } }, "x-ms-visibility": "important", "required": [ "contactID", "destination" ] }, "x-ms-visibility": "important" } ] } }, "/webhooks/{webhook_id}": { "delete": { "consumes": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "object", "properties": {}, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Delete Webhook By ID", "description": "Delete a single webhook object by providing an ID.", "operationId": "DeleteWebhookByID", "x-ms-visibility": "internal", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "type": "integer", "description": "Unique ID of the webhook.", "x-ms-summary": "Unique ID of the webhook.", "x-ms-url-encoding": "single" } ] } }, "/webhooks/CallConnected": { "x-ms-notification-content": { "description": "Provides event with data payload about the call when event CallConnectedEvent is received during a moment when the call is answered.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "CallConnected webhook callback", "description": "Provides event with data payload about the call when event CallConnectedEvent is received during a moment when the call is answered.", "operationId": "CallConnected", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/CallCompleted": { "x-ms-notification-content": { "description": "Provides event with data payload about the call when event CallCompletedEvent is received during a moment when the call has ended.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "connectionTime": { "type": "integer", "format": "int32", "description": "connectionTime" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "previous_contactID": { "type": "integer", "format": "int32", "description": "previous_contactID" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "CallCompleted webhook callback", "description": "Provides event with data payload about the call when event CallCompletedEvent is received during a moment when the call has ended.", "operationId": "CallCompleted", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/VoicemailCreated": { "x-ms-notification-content": { "description": "Provides event with data payload about the voicemail when VoicemailCreated event is received during a moment when a caller has left a voicemail.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "sender": { "type": "string", "description": "sender" }, "voicemailID": { "type": "integer", "format": "int32", "description": "voicemailID" }, "length": { "type": "integer", "format": "int32", "description": "length" }, "callStarted": { "type": "string", "description": "callStarted" }, "voicemailBoxID": { "type": "integer", "format": "int32", "description": "voicemailBoxID" }, "voicemailBoxName": { "type": "string", "description": "voicemailBoxName" }, "messageURL": { "type": "string", "description": "messageURL" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "VoicemailCreated webhook callback", "description": "Provides event with data payload about the voicemail when VoicemailCreated event is received during a moment when a caller has left a voicemail.", "operationId": "VoicemailCreated", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/VoicemailDeleted": { "x-ms-notification-content": { "description": "Provides event with data payload about the voicemail when VoicemailDeleted event is received during a moment when a user has deleted a voicemail message.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "sender": { "type": "string", "description": "sender" }, "voicemailID": { "type": "integer", "format": "int32", "description": "voicemailID" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "VoicemailDeleted webhook callback", "description": "Provides event with data payload about the voicemail when VoicemailDeleted event is received during a moment when a user has deleted a voicemail message.", "operationId": "VoicemailDeleted", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "required": [ "endpoint" ] } } ], "x-ms-visibility": "important" } }, "/webhooks/LostCallerAdded": { "x-ms-notification-content": { "description": "Provides event with data payload data about the call when LostCallerCreated event is received during a moment when the call does not get answered and gets registered as lost.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "contact_name" }, "destination": { "type": "string", "description": "destination" }, "attempts": { "type": "integer", "format": "int32", "description": "attempts" }, "callerid": { "type": "string", "description": "callerid" }, "last_contact": { "type": "string", "description": "last_contact" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "LostCallerAdded webhook callback", "operationId": "LostCallerAdded", "description": "Provides event with data payload data about the call when LostCallerCreated event is received during a moment when the call does not get answered and gets registered as lost.", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/LostCallerUpdated": { "x-ms-notification-content": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "contact_name" }, "destination": { "type": "string", "description": "destination" }, "attempts": { "type": "integer", "format": "int32", "description": "attempts" }, "callerid": { "type": "string", "description": "callerid" }, "last_contact": { "type": "string", "description": "last_contact" } }, "description": "data" } } }, "description": "Provides event with data payload data about the call when LostCallerUpdated event is received during a moment when another unsuccessful call attempt is received from the same number, so lost call record attempts and last_contact fields get updated with a new number and timestamp." }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "LostCallerUpdated webhook callback", "description": "Provides event with data payload data about the call when LostCallerUpdated event is received during a moment when another unsuccessful call attempt is received from the same number, so lost call record attempts and last_contact fields get updated with a new number and timestamp.", "operationId": "LostCallerUpdated", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/LostCallerRemoved": { "x-ms-notification-content": { "description": "Provides event with data payload about the call when LostCallerDeleted event is received during a moment when lost call gets called back from employee or gets answered later in repeated call from the same caller.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "destination": { "type": "string", "description": "destination" }, "callerid": { "type": "string", "description": "callerid" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "LostCallerRemoved webhook callback", "operationId": "LostCallerRemoved", "description": "Provides event with data payload about the call when LostCallerDeleted event event is received during a moment when lost call gets called back from employee or gets answered later in repeated call from the same caller.", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/CallRecorded": { "x-ms-notification-content": { "description": "Provides event with data payload about the call when CallRecorded event is received during a moment when call recording gets created.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "recordingID": { "type": "integer", "format": "int32", "description": "recordingID" }, "callID": { "type": "integer", "format": "int32", "description": "callID" }, "callStarted": { "type": "string", "description": "callStarted" }, "recordingURL": { "type": "string", "description": "recordingURL" }, "direction": { "type": "string", "description": "direction" }, "connectionTime": { "type": "integer", "format": "int32", "description": "connectionTime" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "CallRecorded webhook callback", "operationId": "CallRecorded", "description": "Provides event with data payload about the call when CallRecorded event is received during a moment when call recording gets created.", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/CallTransfered": { "x-ms-notification-content": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "callConnected": { "type": "string", "description": "callConnected" }, "connectionTime": { "type": "integer", "format": "int32", "description": "connectionTime" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "previous_contactID": { "type": "integer", "format": "int32", "description": "previous_contactID" }, "direction": { "type": "string", "description": "direction" } }, "description": "data" } } }, "description": "Provides event with data payload about the call when CallTransfered event is received during a moment when the call gets transferred to a third party either by a blind transfer of attended transfer." }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "CallTransfered webhook callback", "operationId": "CallTransfered", "description": "Provides event with data payload about the call when CallTransfered event is received during a moment when the call gets transferred to a third party either by a blind transfer of attended transfer.", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ], "x-ms-visibility": "important" } }, "/webhooks/CallStarted": { "x-ms-notification-content": { "description": "Provides event with data payload about the call when event CallStarted event is received during the start of the call.", "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "type" }, "version": { "type": "string", "description": "version" }, "eventType": { "type": "string", "description": "eventType" }, "data": { "type": "object", "properties": { "callID": { "type": "integer", "format": "int32", "description": "callID" }, "caller": { "type": "string", "description": "caller" }, "destination": { "type": "string", "description": "destination" }, "direction": { "type": "string", "description": "direction" }, "status": { "type": "integer", "format": "int32", "description": "status" }, "callStarted": { "type": "string", "description": "callStarted" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" } }, "description": "data" } } } }, "post": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "string", "description": "data" } } } } }, "consumes": [ "application/json" ], "summary": "CallStarted webhook callback", "description": "Provides event with data payload about the call when event CallStarted event is received during the start of the call.", "operationId": "CallStarted", "x-ms-visibility": "important", "x-ms-trigger": "single", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint", "title": "Endpoint", "x-ms-visibility": "internal", "x-ms-notification-url": true } }, "x-ms-visibility": "internal", "required": [ "endpoint" ] }, "x-ms-visibility": "internal" } ] } }, "/trigger/groups": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "string", "description": "created" }, "groupID": { "type": "integer", "format": "int32", "description": "groupID" }, "type": { "type": "integer", "format": "int32", "description": "type" }, "name": { "type": "string", "description": "name" }, "members": { "type": "array", "items": { "type": "object", "properties": { "contactID": { "type": "integer", "format": "int32", "description": "contactID" } } }, "description": "members" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Groups", "description": "Retrieve Employee groups data. Additionally API consumer may filter the returned records based on contact_id, to limit the result to only those groups, which have a particular Employee as a member.", "operationId": "GetGroups", "x-ms-visibility": "important", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "group_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the group.", "x-ms-summary": "Group ID" }, { "name": "initial_group_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial group ID for querying only newly created employee groups.", "x-ms-summary": "Initial group ID" }, { "name": "contact_id", "in": "query", "required": false, "type": "integer", "description": "Unique ID of the Employee.", "x-ms-summary": "Contact ID" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" } ], "x-ms-trigger-hint": "Triggers when a new employee group is created" } }, "/trigger/contacts": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "current_callerid": { "type": "string", "description": "current_callerid" }, "archived": { "type": "integer", "format": "int32", "description": "archived" }, "firstname": { "type": "string", "description": "firstname" }, "lastname": { "type": "string", "description": "lastname" }, "created": { "type": "string", "description": "created" }, "number": { "type": "string", "description": "number" }, "contactID": { "type": "integer", "format": "int32", "description": "contactID" }, "group_membership": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "string", "description": "created" }, "groupID": { "type": "integer", "format": "int32", "description": "groupID" }, "type": { "type": "integer", "format": "int32", "description": "type" }, "name": { "type": "string", "description": "name" }, "members": { "type": "array", "items": { "type": "object", "properties": { "contactID": { "type": "integer", "format": "int32", "description": "contactID" } } }, "description": "members" } } }, "description": "group_membership" }, "avatar": { "type": "string", "description": "avatar" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get Contacts", "description": "Triggers when a new employee is created", "operationId": "GetContacts", "x-ms-visibility": "important", "x-ms-trigger": "batch", "x-ms-trigger-metadata": { "mode": "polling", "kind": "query" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset" }, { "name": "contact_id", "in": "query", "required": false, "type": "integer", "x-ms-visibility": "important", "description": "Unique ID of the Employee.", "x-ms-summary": "Contact ID" }, { "name": "initial_contact_id", "in": "query", "required": true, "type": "integer", "default": 0, "x-ms-visibility": "internal", "description": "Initial contact ID for querying only newly created employees.", "x-ms-summary": "Initial contact ID" } ], "x-ms-trigger-hint": "Triggers when a new employee is created" } }, "/lost_calls": { "get": { "responses": { "200": { "description": "OK", "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "version" }, "status": { "type": "string", "description": "status" }, "statusCode": { "type": "integer", "format": "int32", "description": "statusCode" }, "message": { "type": "string", "description": "message" }, "data": { "type": "array", "items": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "contact_name" }, "destination": { "type": "string", "description": "destination" }, "attempts": { "type": "integer", "format": "int32", "description": "attempts" }, "callerid": { "type": "string", "description": "callerid" }, "last_contact": { "type": "string", "description": "last_contact", "title": "Last contact", "format": "date-time" } } }, "description": "data" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get lost calls", "description": "Retrieve all lost call records from call history that have not been answered, have been called back or the caller has not reached the employee in repeated attempts within the same day.", "operationId": "GetLostCalls", "x-ms-visibility": "important", "parameters": [ { "name": "limit", "in": "query", "required": false, "type": "integer", "description": "Limit how many results to retrieve.", "x-ms-summary": "Limit", "x-ms-visibility": "important" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "description": "Used to specify from which result we want the data to retrieve.", "x-ms-summary": "Offset", "x-ms-visibility": "important" }, { "name": "destination", "in": "query", "required": false, "type": "string", "description": "The number which call was placed to.", "x-ms-summary": "Destination", "x-ms-visibility": "important" }, { "name": "date_from", "in": "query", "required": false, "type": "string", "description": "Starting date in the filtered date range.", "x-ms-summary": "Date from", "x-ms-visibility": "important", "format": "date-time" }, { "name": "date_to", "in": "query", "required": false, "type": "string", "description": "End date in the filtered date range.", "x-ms-summary": "Date to", "x-ms-visibility": "important", "format": "date-time" } ] } } }, "definitions": {}, "parameters": {}, "responses": {}, "securityDefinitions": { "API Key": { "type": "apiKey", "in": "header", "name": "Authorization" } }, "security": [ { "API Key": [] } ], "tags": [] }