Get Driver Config

This API is used to get switchboard configuration information.

Note:

  • For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

  • For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

GetDriverConfig

post
Body
objectOptional
Responses
200
A successful response
application/json
post
POST /GetDriverConfig HTTP/1.1
Host: $BASE_URL.ETelecom
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

A successful response

{
  "connection_id": "text",
  "push_head": "text",
  "push_id": "text",
  "sip_domain": "text",
  "sip_port": 1,
  "transport": "text",
  "version": "text",
  "websocket_url": "text"
}

Request:

curl --location '$BASE_URL.Etelecom/GetDriverConfig' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{}'

Response:

{
  "connection_id": "string",
  "push_head": "string",
  "push_id": "string",
  "sip_domain": "string",
  "sip_port": 0,
  "transport": "string",
  "version": "string",
  "websocket_url": "string"
}

Return data attribute structure:

Parameters
Data type
Describe

connection_id

string

Session ID

push_head

string

Push notification method

push_id

string

Push notification ID

sip_domain

string

Switchboard domain

sip_port

int

Switchboard port

transport

string

Connection port information

version

string

Switchboard version

websocket_url

string

Websocket connection link

Last updated