Integration
Purpose
To enable or disable the provider integration within PhoneBridge.
Request URL
https://www.zohoapis.com/phonebridge/v3/integrate
Request Method
POST - To enable integration
DELETE - To disable integration
Possible Errors
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 400 | SC_BAD_REQUEST | PROVIDER_NOT_REGISTERED | The PhoneBridge registration information is not available for the Provider name obtained from the OAuth Token object. |
| 403 | SC_FORBIDDEN | INTERNAL_ERROR | Requested user does not have enough privilege in Zoho PhoneBridge to enable the PhoneBridge integration. |
| 403 | SC_FORBIDDEN | DIFFERENT_PROVIDER_ALREADY_ENABLED | A different Provider integration has been enabled for the account already. |
| 500 | SC_INTERNAL_SERVER_ERROR | INTERNAL_ERROR | An exception occurred while processing the request. |
Sample Request to Enable Integration
Copiedcurl "https://www.zohoapis.com/phonebridge/v3/integrate"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxx.ef77Sample Response
Copied{
"message": "(Provider Name) Integration is successful"
"status":"success",
"code":"SUCCESS"
}Sample Request to Disable Integration
Copiedcurl "https://www.zohoapis.com/phonebridge/v3/integrate"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxx.ebd1"Sample Response
Copied{
"message": "(Provider Name) Integration has been successfully removed"
"status":"success",
"code":"SUCCESS"
}