Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The service is initiated using HTTPS using HTTPS post and queried using HTTPS get. HTTP is also supported with Digest authentication but it is not the preferred method of service invocation.

Services

If you are calling issuing the curl command  from a trusted host ( i.e. one where sipx proxy is running) please use only HTTPS (no authentication is required).
If you are calling from a different host, then From a non-trusted host you must authenticate the curl command with Digest authentication.

...

You can use either HTTPS or HTTP when using issuing the curl command from a non-trusted host.

The URI is as documented below:

URI

URL Pararameters (Optional)

Methods

Formats

callcontroller/{callingUser}/{calledUser}

sipMethod=[REFER|xecsdev:INVITE]  the default is REFER

action=[call|xecsdev:transfer] the default action is call

target=<targetUser> the target user for the call transfer. If an ongoing call exists, the call is transferred to the targetUser. This is meaningful only if the call was previously started using INVITE.

timeout=<seconds> - the time for which the calling party is alerted before pickup. If the callng party does not pickup in that time period, the call is aborted.

agent=<agentUser> the user name of the agent that is placing the third party call. This defaults to the callingUser

subject=<subject> Subject of the call. Determines what goes into the SIP subject header of the initial call setup INVITE.

isForwardingAllowed=[true|xecsdev:false] default is false whether or not forwarding is allowed for the initial INVITE

resultCacheTime=<seconds> The amount of time for which to keep the call progress cache record in memory.

POST

Initiates a call from the callingUser to the calledUser

callcontroller/{callingUser}/{calledUser}

All URL parameters are ignored. Note that you an only get the current call state of you have previously initiated the call from callingUser to calledUser

GET

Get the current call state for any ongoing call between callingUser and calledUser

...