Buzzeasy REST API
Buzzeasy Campaign API
The campaign API provides the interface for the campaign endpoints to integrate to the buzzeasy campaign. The following methods are exposed;
Parameters
| Name | Type | Description |
|---|---|---|
| firstName | string | The first name of the contact. |
| secondName | string | The full name of the requestor. |
| phoneNo | string | The phone number the contact would like to be reached on. This must be in E.164 format if the region is not supplied. |
| campaignId | int | The campaign (ID) that the record wishes to use. This is supplied by Buzzeasy during the setup phase. |
| region | string | The region of the phone number. This region will be used if the phone number has not been formatted in E.164 format. Please see Appendix A for list of valid regions |
| field1 | string | An optional field that can be used to include further information regarding the request/call |
| field2 | string | An optional field that can be used to include further information regarding the request/call |
| field3 | string | An optional field that can be used to include further information regarding the request/call |
| field4 | string | An optional field that can be used to include further information regarding the request/call |
| field5 | string | An optional field that can be used to include further information regarding the request/call |
| field6 | string | An optional field that can be used to include further information regarding the request/call |
| field7 | string | An optional field that can be used to include further information regarding the request/call |
| field8 | string | An optional field that can be used to include further information regarding the request/call |
| field9 | string | An optional field that can be used to include further information regarding the request/call |
| field10 | string | An optional field that can be used to include further information regarding the request/call |
Response
The following responses are available upon making a request to the API
| Code | Description | Comments |
|---|---|---|
| 201 | Created | Created |
| 400 | Parameters passed across are invalid. | Bad Request |
| 400 | The phone number passed across is invalid and cannot be formatted | Bad Request |
| 401 | The token issued has expired or invalid | Unauthorised |
Authorisation
The authorisation for the API follows the OAuth2 flow and uses JWT token using bearer authentication. Long life tokens can be issued by Geomant to use bearer authentication or a token can be issued from the Geomant Auth h (G-OAuth) service for usage.
The token will include the following;
Scopes: "buzzeasy.callback"
Properties: "buzzeasy.TenantId": "<CompanyID>"
Callback API
The callback API provides the interface for services to integrate to callback. This can be used to schedule callbacks or to issue immediate callbacks when necessary
Parameters
| Name | Type | Description |
|---|---|---|
| Name | string | The full name of the callback request |
| phoneNo | string | The phone number the contact would like to be reached on. This must be in E.164 format if the region is not supplied. |
| serviceQueue | int | The service queue (ID) that the record wishes to use. This is supplied by Buzzeasy during the setup phase. |
| region | string | The region of the phone number. This region will be used if the phone number has not been formatted in E.164 format. Please see Appendix A for list of valid regions |
| fields | String[] | optional field(s) that can be used to include further information regarding the request/call |
| timeslot | Int? | The timeslot ID if the callback is a scheduled callback. |
| date | string | The date of the callback to be scheduled |
| callType | Int | 1 = Call When Available 2 = Call Scheduled |
Response
The following responses are available upon making a request to the API
| Code | Description | Comments |
|---|---|---|
| 201 | Created | Created |
| 400 | Parameters passed across are invalid. | Bad Request |
| 400 | The phone number passed across is invalid and cannot be formatted | Bad Request |
| 401 | The token issued has expired or invalid | Unauthorised |
Authorisation
The authorisation for the API follows the OAuth2 flow and uses JWT token using bearer authentication. Long life tokens can be issued by Geomant to use bearer authentication or a token can be issued from the Geomant Auth (G-OAuth) service for usage. The token will include the following;
Scopes: "buzzeasy.callback"
Properties: "buzzeasy.TenantId": "<CompanyID>"