Get Inboxes list


Get inboxes list of an account.


Settings:

URL

https://partners.99digital.co.il/api/online/getInboxes

Method

JSON via POST

Header

Authorization: Bearer {{access_token}}

*The access_token can be received from settings->get access token API.


Body:

Parameter

Description / Example

accountID

The accountID you wish to get the agents list

server

server subdomain hosting the account (default is: online)

if not set, "online" will be used.


Response:

{
    "status": "OK",
    "reason": 1,
    "accountID": 1,
    "server": 1,     
    "totalInboxes": 2,
    "list": [
        {
            "id": 1,
            "name": "Inbox name",
            "channel_type": "Channel::Api",
            "api_type": "wa_v2"
        }
    ]
}


Response-Explain:

Parameter

Description

status

OK or FAIL

"OK" means the request was successful.

"Fail" means error.

totalAgents

The total number of agents in the selected account

list

array of the following table []:

name

explanation

id

Inbox ID

name

The inbox name

channel_type

The channel type

api_type

If channel_type is "Channel:Api", here it will show the api type. otherwise it will be null

reason

'reason' is the status explanation in case of FAIL

1

not FAIL. the status is OK

2

Wrong credentials

3

Access token does not exist or expired, please generate another one from Settings - Get access token API

13

you need to use POST method.

33

accountID is invalid or wrong

34

server is invalid or wrong