exosip2ctypes.call module

eXosip call API

This file provide the API needed to control calls. You can use it to:

  • build initial invite.
  • send initial invite.
  • build request within the call.
  • send request within the call.
This API can be used to build the following messages:
INVITE, INFO, OPTIONS, REFER, UPDATE, NOTIFY
class exosip2ctypes.call.InitInvite(context, to_url, from_url, route=None, subject=None)

Bases: exosip2ctypes.message.ExosipMessage

default INVITE message for a create call.

Build a default INVITE message for a create call.

Parameters:
  • Context context (Context) – Context object contains the eXosip_t instance.
  • to_url (str) – SIP url for callee.
  • from_url (str) – SIP url for caller.
  • route (str) – Route header for INVITE. (optional)
  • subject (str) – Subject for the call.
from_url

SIP url for caller.

Return type:str
route

Route header for INVITE. (optional)

Return type:str
subject

Subject for the call.

Return type:str
to_url

SIP url for callee.

Return type:str
class exosip2ctypes.call.Ack(context, did)

Bases: exosip2ctypes.message.ExosipMessage

default ACK for a 200ok received.

Build a default ACK for a 200ok received.

Parameters:
  • context (Context) – eXosip instance.
  • did (int) – dialog id of call.
did
Returns:dialog id of call.
Return type:int
send()

Send the ACK for the 200ok received.

class exosip2ctypes.call.Answer(context, tid, status)

Bases: exosip2ctypes.message.ExosipMessage

default Answer for request.

Build default Answer for request.

Parameters:
  • context (Context) – eXosip instance.
  • tid (int) – id of transaction to answer.
  • status (int) – Status code to use.
send()

Send Answer for invite.

status
Returns:Status code to use.
Return type:int
tid
Returns:id of transaction to answer.
Return type:int