Mediaservice

Set this to the value of replyId received in the callAnswered callback for the connection.

The id for the participant to be hung up.

Set this to the value of replyId receviced in the callNotify or callAnswered originating from the particpant or connection related to partcipant to be hung up.

Set this to the value of replyId received in the callAnswered callback for the connection

The file name that will be used when the call recording is uploaded to the prompt storage.

Set this to the value of replyId received in the callAnswered callback for the connection.

Specifies the voice codec to be requested from the remote side for the call. Allowed values are PCMA or PCMU

This is an optional property to be set by the system calling the API. If this is set the value will be copied into callback requests related to the session originating from the API call.

Set this propery to the replyId received from the newRemoteCall callback to answer the call.

Specifies the RTP port where the remote side shall send media.

Specifies the voice codec to be requested from the remote side for the call. Allowed values are PCMA,PCMU or GSM

This is an optional property to be set by the system calling the API. If this is set the value will be copied into callback requests related to the session originating from the API call.

SIP URI for the remote side of the call to be set up by the cloud SIP user agent.

Specifies the user part of the from: URI for the call triggered. This will be indicated as the calling party number for the remote side.

Specifies the RTP port where the remote side shall send media.

Specifies the IP address that the remote side shall send media to.

User part of from: header in the. Set this to the phone number or user id to be displayed for the remote party.

This property allow custom X- headers to be added to the SIP request of the call generated in case the action is set to call. It take an object of format {x-header1:val1, x-header2:val2} as value resulting in the SIP headers and values X-Header1: val1 and X-Header2: val2. To set multiple header values for same header pass an array : {x-header3: [val1,val2]}.

Optional sessionReferenceId object that is copied into the sessionReferenceId property in subsequent callback requests for the session created.

It defines which number should be placed in SIP-Diversion header if action is “call”. If this parameter is omitted then no SIP-Diversion header should be included in the SIP-INVITE.

If this property is set the value is set as display name in the the from: header of the SIP request for the outgoing IVR call

Indicates if the calling party number should be hidden in the call that is set up from the IVR as result of the placeivrcall API request.

This property allow custom URL parameters to be added to the contact: header of the call generated in case the action is set to call. It take an object of format {prop1:val1, prop2:val2} as value resulting in the URL parameters prop1=val1;prop2=val2 to be appended to the URL in contact: header.

An object of format {param:paramValue} which sets the header parameters for the diversion header

This property allow custom P- headers to be added to the SIP request of the call generated in case the action is set to call. It take an object of format {p-header1:val1, p-header2:val2} as value resulting in the SIP headers and values P-Header1: val1 and P-Header2: val2. To set multiple header values for same header pass an array : {p-header3: [val1,val2]}.

This property allow custom user parameters to be added to the contact: header of the call generated in case the action is set to call. It take an object of format {prop1:val1, prop2:val2} as value resulting in the user parameters prop1=val1;prop2=val2 to be appended to the user part of URL in contact: header.

SIP URI pointing to the destination to be connected with the IVR service.

If this property is set the value is matched against the id property of the provisioned meddia server configurations. The matching configuration is used for the mediaserver session resulting to the API call. If this property is not passed configuration of the first provisioned mediaserver configuration will be used.

The id for the participant for which it's remote party is to be hung up.

Set this to the value of replyId receviced in the getIvrCommand request that started the command to be interrupted.

Indicates if the event belong to a call monitoring leg

Unique id for the participant tha the event is associated with

The sessionId identifies the session

If this value has been set in invoking API call the value is copied to subsequent callback requests

SIP user part of the participant that caused the event to be sent

SIP user part for the participant of the remote side of the connection for the participant that caused the event to be sent

Unique of for the participant of the remote side of the connection for the participant caused the event to be sent

The sipCallId is the corresponding value from SIP-Invite

The ivrServer is the IP address of the node that sends the command

traceId is a unique identifier for an entire call that may span multiple sessions. Makes it easier to track calls through the platform.

An identifier for the specific site running the service. Only used in the hybrid environment

SIP user part of calling party in the call that has been connected

participantId of calling party in the call that has been connected

participantId of called party in the call that has been connected

SIP user part of called party in the call that has been connected

The id for the connection that the participants in the call belongs to

If the calling party SIP call leg has a session expiration the value is indicated here

If the called party SIP call leg has a session expiration the value is indicated here

This field is only present if the httpcall action was used to connect the participants. The codec received in SDP to be used by the device behind CloudUA to send media to

Indicates if the event belong to a call monitoring leg

This field is only applicable and mandatory for the httpcall action. The IP address received in SDP to be used by the device behind CloudUA to send media to

This field is only applicable and mandatory for the httpcall action. The IP port received in SDP to be used by the device behind CloudUA to send media to

The replyId property must be copied into subsequent requests related to this call.

If this value has been set in invoking API call the value is copied to subsequent callback requests

traceId is a unique identifier for an entire call that may span multiple sessions. Makes it easier to track calls through the platform.

An identifier for the specific site running the service. Only used in the hybrid environment

The sessionId identifies the current session

The sipCallId is the corresponding value from SIP-Invite

The ivrServer is the IP address of the node that sends the command

The callingPartyPrivacy tells if aNumber is “public” or “secret”

The value of the callingParty property is the user part of SIP URI in P-Asserted identity header of incoming SIP request or if this header is not present it is retrieved from the from: header.

The displayName property is set if there is a display-name present in either P-Asserted-Identity: header or from: header of the incoming request triggering the /newCall request. If it is present in both headers with different values the P-Asserted-Identity display-name value is used.

The value of the fromUser property is the user part of SIP URI in from: header of incoming SIP request. NOTE: It is recommended to use value of the callingParty property since this is more thrustworthy since it consider the PAI header if present. The from: header is set by the user's device and may contain any number.

This property is set to an object that contains SIP headers starting with prefix X- in the inbound SIP request that triggered the /newCall callback and their values. The object is of format {"x-header1":"value1","x-header2":"value2"}. In case of multiple header values for same header it returns an array : {"x-header3": ["val1","val2"]}.

This property is set to an object that contains SIP headers starting with prefix P- in the inbound SIP request that triggered the /newCall callback and their values. The object is of format {"p-header1":"value1","p-header2":"value2"}. In case of multiple header values for same header it returns an array : {"p-header3": ["val1","val2"]}.

This property is set to an array that contains the names of SIP headers starting with either the prefix P- or X- to copy from the incoming call.

The calledParty is the access number that is used to access the IVR.

This value is present if the SIP request triggering the /newCall request had any diversion headers. The value holds the content of these headers.

This value is present if the SIP request triggering the /newCall request had any referred-by header. The value holds the content of this header.

The paiNumber is the E.164-number presented in the SIP PAI header

The subject is the value in the SIP subject header

The sessionId identifies the current session

The sessionId identifies the current session

The domain configured for the tenant triggering the event

SIP user part of calling party in the call that has been connected

participantId of calling party in the call that has been connected

Object that is retained for the session and passed in subsequent requests

The ivrServer is the IP address of the node that sends the command

traceId is a unique identifier for an entire call that may span multiple sessions. Makes it easier to track calls through the platform.

An identifier for the specific site running the service. Only used in the hybrid environment

Unique id of the connection that the participant that caused the event to be sent belonged to

The domain configured for the tenant triggering the event

The type of event that triggered the /callEvent to be sent

The ivrServer is the IP address of the node that sends the command

Unique id for the participant that caused the event to be sent

Unique of for the participant of the remote side of the connection for the participant caused the event to be sent

SIP user part for the participant of the remote side of the connection for the participant that caused the event to be sent

The sessionId identifies the current session

SIP user part of the participant that caused the event to be sent

The replyId property must be copied into subsequent requests related to this call.

The SIP Call-Id for the call that has been answered by the remote side

The codec that the remote side want to receive.

The SIP request URI of the incoming call.

The user part of the SIP from: header of the incoming call

The IP address that the remote side want to receive media on

The sessionId identifies the session

Uniquely identifies the call in the remote system

The IP address of the IVR node originating the request

Holds the received DTMF digits in the buffer since last flushed. dtmfBuffer may be encrypted according to instructions in last response to getIvrCommand. If there are no DTMF in buffer then this parameter could be omitted

The sessionId identifies the session

The connectionId for the call connection that was recorded

The file name representing the recording in the prompt storage

The size of the recorded file in bytes

The ivrServer is the IP address of the node that sends the callback

The domain for the tenant that use the service

The type of event that triggered the /recordingReady to be sent

The type of alarm event. The following types may be sent with the specified error types

• sessionError - Alarms raised at session level
  • maxDuration - The session was terminated since the maximum session duration was reached
• callEventError - Alarms raised related to /callEvent callback requests
  • No response to callEvent request - The /callEvent callback did not get any response
  • Invalid sip address:
    - The provided SIP address in destAddr property in /callEvent response is invalid
  • callEvent response with unknown action - An invalid action was provided in the /callEvent response
  • No action provided in callEvent response - Action was not provided in the /callEvent response
• newCallEventError - Alarms raised related to /newCall callback requests
  • newCall response empty - The response the the /newCall event did not contain any body
  • newCall response without action - Action was not provided in the /newCall response
  • newCall response with unknown action - An invalid action was provided in the /newCall response
  • newCall request failed - The /newCall request failed
• emergencyFallback - Incoming call to the mediaservice was handled according to provisioned emergency fallback logic
  • triggeredByAlways - The called destination was configured to always invoke the emergency routing logic
  • triggeredByError - The emergency routing logic was triggered due to failure to invoke the /newCall API
• ivrCommandError - Alarms raised related to /getIvrCommand callback requests
  • phraseError - An invalid phrase was provided in the /getIvrCommand callback response
  • mediaServerError - An error occurred in the media service processing the command provided in /getIvrCommand callback response
  • Empty body in getIvrCommand response - No body was provided in the response to /getIvrCommand callback
  • getIvrCommand request error - Error sending the /getIvrCommand callback request
  • IVR command failed - Mediaservice failed to execute the command provided in the /getIvrCommand callback response
• callError - Alarms raised in relation to the call handling to and from the media service
  • RTP media timeout - The media service was terminated due to no media (RTP packets) received from the remote party
  • invalidSdp - A call with invalid SDP was rejected by the mediaservice
  • sessionExpired - A call handled by mediaservice was terminated to to SIP session expiration, i.e. no session refresh was received for the session
  • cancelFailed - A SIP Cancel request sent by the mediaservice was responded to with a non-200 final response
  • unexpectedReinviteResponse - Am unexpected response for a SIP reinvite was receieved

The domain that triggered the alarm event

The sessionId of the call that triggered the alarm event

The type of error that triggered the alarm event

Optional object that provide more details of the cause of the alarm event to be used for debug purpose.

Applicable for callError:unexpectedReinviteResponse - contains the status code received from the remote end.

Applicable for callError:unexpectedReinviteResponse - contains the participant ID.

Applicable for callError:unexpectedReinviteResponse - user that caused the response.