Voice Application Subscriber Data
You may explore this data model via the API Playground, by clicking here
Endpoints
/tenants/{tenant-name}/domains/{domain}/applications/{application-name}/subscribers/{subscriber-msisdn}
The Cloudonix application subscriber data model allows Cloudonix voice applications to safely and easily store and load subscriber specific application data, similar to how web applications can store data in cookies sent and received from the viewers' browsers.
For each subscriber that interacts with a voice application, there is a unique storage space that allows the voice application to record various data points associated with custom data keys - similar to a key-value store.
The data can be anything that can be encoded as text, though JSON encoded data is highly recommended. Keys are expected to be short text identifiers.
Properties
| Property | Type | Editable | Description |
|---|---|---|---|
application | Object | No | The Cloudonix Voice Application object for which this subscriber data was stored. |
subscriber | Object | No | The Cloudonix Subscriber object for which this subscriber data was stored. |
key | String | Create | The identifying data key. |
data | String | Create, Update | The value stored. |
createdTime | String | No | Time this value was first created for the subscriber, as an ISO 8601 UTC time stamp. |
modifiedTime | String | No | Time this value was last modified for the subscriber, as an ISO 8601 UTC time stamp. |
The endpoint supports only the following oeprations:
GET …/{subscriber-msisdn}
Retrieve a list of the current values of all keys in the format specified above.
PUT …/{subscriber-msisdn}/{key}
Update the data value associated with a key - creating it if it does not exist. The body of the request will be read as the text data to set for they key.
Get …/{subscriber-msisdn}/{key}
Read the current value of a key, returninga 404 Not Found error if it does not exist.
The body of the response will be the text value of data stored for the key.