curl --request POST \
--url https://api.messaging.phonovation.com/ccaas/2/conversation-forms/fields \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Inquiry",
"type": "TEXT"
}
'{
"id": "ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title": "Inquiry",
"type": "TEXT",
"regex": null,
"isEnabled": true,
"options": [],
"createdAt": "2021-06-29T10:00:55.755685Z",
"updatedAt": "2021-06-29T10:00:55.755686Z",
"operators": []
}Create field
Use this method to create a field.
Required scope: Enable one of: conversations:manage.
curl --request POST \
--url https://api.messaging.phonovation.com/ccaas/2/conversation-forms/fields \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Inquiry",
"type": "TEXT"
}
'{
"id": "ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title": "Inquiry",
"type": "TEXT",
"regex": null,
"isEnabled": true,
"options": [],
"createdAt": "2021-06-29T10:00:55.755685Z",
"updatedAt": "2021-06-29T10:00:55.755686Z",
"operators": []
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Body
Field title.
100Field type.
TEXT, MULTILINE, CHECKBOX, DROPDOWN, INTNUMBER, DECIMALNUMBER, REGEX, DATE, CARD Is field enabled. Mandatory when updating.
Available field options. Applicable only for DROPDOWN type.
Available field options. Applicable only for DROPDOWN type.
Regular expression. Applicable only for REGEX type.
Response
OK
Field id.
Field title.
Field type.
TEXT, MULTILINE, CHECKBOX, DROPDOWN, INTNUMBER, DECIMALNUMBER, REGEX, DATE, CARD Regular expression. Valid only for REGEX field type.
Is field enabled
List of available options.
List of available options.
List of available operators based on field type.
List of available operators based on field type.
IS, IS_NOT, CONTAINS, DOESNT_CONTAIN, IS_SELECTED, NOT_SELECTED, IS_EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, GREATER_THAN, IS_EQUAL_OR_LESS, IS_EQUAL_OR_GREATER, BEFORE, AFTER, BEFORE_OR_ON, AFTER_OR_ON