All URIs are relative to https://secure.ultracart.com/rest/v2
| Method | HTTP request | Description |
|---|---|---|
| embedOauthDeviceAuthorize | POST /conversation_embed/oauth/device/authorize | Initiate a device authorization flow for an embed widget. |
| embedOauthRevoke | POST /conversation_embed/oauth/device/revoke | Revoke an embed widget access or refresh token. |
| embedOauthToken | POST /conversation_embed/oauth/device/token | Exchange a device_code or refresh_token for an access token (embed widget). |
| getEmbedPbxAuth | PUT /conversation_embed/pbx-auth | Get PBX authorization for the embedded softphone widget. |
embedOauthDeviceAuthorize(clientId, scope)
Initiate a device authorization flow for an embed widget.
RFC 8628 device authorization. Only the embed widget's client_id and the crm_embed scope are accepted.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| clientId | String | The embed widget OAuth client_id. | |
| scope | String | The application-level scope (must be 'crm_embed'). |
null (empty response body)
ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - | |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
embedOauthRevoke(clientId, token)
Revoke an embed widget access or refresh token.
RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the 'token' parameter.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| clientId | String | The embed widget OAuth client_id. | |
| token | String | The token to revoke (access token or refresh token). |
null (empty response body)
ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - | |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
embedOauthToken(clientId, grantType, deviceCode, refreshToken)
Exchange a device_code or refresh_token for an access token (embed widget).
Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| clientId | String | The embed widget OAuth client_id. | |
| grantType | String | Grant type. | |
| deviceCode | String | The device code received from /oauth/device/authorize (required for device_code grant). | [optional] |
| refreshToken | String | The refresh token (required for refresh_token grant). | [optional] |
null (empty response body)
ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - | |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
ConversationEmbedPbxAuthResponse getEmbedPbxAuth()
Get PBX authorization for the embedded softphone widget.
Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.
(No example for this operation).
This endpoint does not need any parameter.
ConversationEmbedPbxAuthResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |