SIP

API for communication with ZBOS by Zora Robotics.

Channels

zbos/sip/config/event

subscribe

SIP config changed

Channel tags
  • SIP

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/sip/errors/get

publish

Get SIP errors

Channel tags
  • SIP

Message 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}

subscribe

response: SIP errors

Channel tags
  • SIP

Message 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

publish

End the current SIP call

Channel tags
  • SIP

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/sip/call/end/event

subscribe

The current SIP call has ended

Channel tags
  • SIP

Message CallEndInfo
Payload

Name

Type

Description

Accepted values

success

boolean

Any

Examples of payload
{
  "success": true
}