Communications

Create a Call

Creates a new call.

post/admin/communications/calls

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/communications/calls
Auth: HTTP basic

Request body

idstring

Call ID

fromstring required

Phone number of author

tostring required

Phone number of receiver

durationnumber required

Duration of the call in seconds

directionstring

Call direction: : 'incoming', 'outgoing'. If empty will be detected automatically

commentstring

recording_urlstring

Url of the page where you can view recording

voice_file_urlstring

Link to recording file. Needed for playback in system

datetimestring required

Date of call

ticket_idnumber

Ticket id. If you want link call to the ticket

client_idnumber

Customer/Lead id. If empty will be defined by phone number

agent_idnumber

Agent(admin) id. If empty will be defined by phone number

added_by'system' | 'api' | 'admin'

The identifier who added the communication call

added_by_idnumber

Example request

{
  "id": "1",
  "from": "1234500",
  "to": "5432100",
  "duration": 60,
  "direction": "incoming",
  "comment": "Text coment",
  "recording_url": "http://test.resource.com/recording",
  "voice_file_url": "http://test.resource.com/get-file",
  "datetime": "2021-09-07 10:00:00",
  "ticket_id": 1,
  "client_id": 1,
  "agent_id": 1,
  "added_by": "system",
  "added_by_id": 1
}

Response

idnumber required

Call ID

Example response

{
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.