SIP

API for communication with ZBOS by Zora Robotics.

Channels

zbos/sip/config/event

SUB SIP config changed

Channel tags

  • SIP

EmptyMessage

Empty message

zbos/sip/errors/get

PUB Get SIP errors

see zbos/sip/errors/response/\{key} for response

Channel tags

  • SIP

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/sip/errors/response/\{key}

SUB response: SIP errors

Channel tags

  • SIP

Array<SipError>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. error

string

Any
Examples of payload
{
  "error": "string"
}

zbos/sip/call/end

PUB End the current SIP call

Channel tags

  • SIP

EmptyMessage

Empty message

zbos/sip/call/end/event

SUB The current SIP call has ended

Channel tags

  • SIP

CallEndInfo
Payload

Name

Type

Description

Accepted values

success

boolean

Any
Examples of payload
{
  "success": true
}

zbos/sip/registration/status/event

SUB event: Registration status

The current SIP registration status, calls cannot be made until registration has succeeded

Channel tags

  • SIP

RegistrationStatusEvent
Payload

Name

Type

Description

Accepted values

uri

string

The uri used for this registration

Any

error

string

Error message for this status, only defined if status is disconnected

Any

status

string

* connecting * connected * disconnected
Examples of payload
{
  "uri": "sip:username@sip.service.com:5060",
  "status": "connected"
}
{
  "uri": "sip:username@sip.service.com:5060",
  "error": "DATA_CONNECTION_LOST: no data connection",
  "status": "disconnected"
}