post
https://connect.routee.net/viber/session
Response parameters
| Parameter | Type | Description |
|---|---|---|
| content | Array of Session Objects | An array containing session objects where the phone used in the query is either the sender or the recipient. |
| last | Boolean | Whether the current page is the last one. |
| totalPages | Integer | The number of total pages. |
| totalElements | Integer | The total amount of elements for the current search. |
| numberOfElements | Integer | The number of elements currently on this page. |
| first | Boolean | Whether the current page is the first one. |
| size | Integer | The requested page size. |
| number | Integer | The requested page number. |
Session object
| Parameter | Type | Description |
|---|---|---|
| sessionId | String | The session id returned by Viber when a message fulfils the requirements to be in a session. |
| sessionMessages | Array of Viber messages. | Viber messages belonging to the same session. The phone number used in the query will have to be the recipient or the sender. |
Session Message (Same as Viber Message)
| trackingId | String | The tracking id of the individual message. |
| to | String | The recipient of the message |
| from | String | The sender of the message |
| country | String | The country of the recipient. (If applicable) |
| status | Status object | The object with the status of the message. |
| applicationName | String | The Routee application name that was used to generate the auth token for the API usage |
| direction | Enumerator String | The direction of the message, possible values Inbound, Outbound |
| ttl | String | Time range until message expires. |
| message | String | The text of the viber message. |
| imageUrl | String | The url of the image. |
| file | File object | An object holding the variables of a file exchanged between BA and customer. |
Status object
| Parameter | Type | Direction |
|---|---|---|
| status | Enumerator String | The current status of the viber message. Check here for possible values. |
| date | String | The updated date of the status. |
| reason | Reason object | The reason of the status. |
Reason object
| Parameter | Type | Description |
|---|---|---|
| detailedStatus | String | The current detailed status. Check here for details. |
| description | String | The description of the detailed status. |
File object
| Parameter | Type | Description |
|---|---|---|
| fileUrl | String | The url of the file sent / received |
| fileType | String | The type of the file sent / received. |
| fileName | String | The name of the file sent / received. |
Viber Video Object
| Parameter | Type | Description |
|---|---|---|
| videoUrl | String (1000 max chars, only https) | The URL where the video is hosted. |
| videoThumbnail | String (1000 max chars, only https) | The URL of a thumbnail for the Video. |
| fileSize | Integer (positive number, 200 max) | The file size in MB. |
| duration | Integer (positive number, 600 max) | The video’s duration in seconds. |