ultracart\v2\ConversationApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method	HTTP request	Description
deleteConversationCannedMessage	DELETE /conversation/canned_messages/{conversation_canned_message_oid}	Delete a conversation canned message
deleteDepartment	DELETE /conversation/departments/{conversation_department_oid}	Delete a conversation department
deleteEngagement	DELETE /conversation/engagements/{conversation_engagement_oid}	Delete a conversation engagement
deletePbxAgentVoicemail	DELETE /conversation/pbx/agent/voicemails/{recording_sid}	Delete Agent Voicemail
deletePbxAudio	DELETE /conversation/pbx/audio/{conversationPbxAudioUuid}	Delete pbx audio
deletePbxMenu	DELETE /conversation/pbx/menu/{conversationPbxMenuUuid}	Delete pbx menu
deletePbxQueue	DELETE /conversation/pbx/queue/{conversationPbxQueueUuid}	Delete pbx queue
deletePbxQueueVoicemail	DELETE /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}	Delete Queue Voicemail
deletePbxTimeBased	DELETE /conversation/pbx/time_based/{conversationPbxTimeBasedUuid}	Delete pbx timeBased
deletePbxTimeRange	DELETE /conversation/pbx/time_range/{conversationPbxTimeRangeUuid}	Delete pbx timeRange
deletePbxVoicemailMailbox	DELETE /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}	Delete pbx voicemailMailbox
getAgentKeepAlive	GET /conversation/agent/keepalive	Agent keep alive
getAgentProfile	GET /conversation/agent/profile	Get agent profile
getAgentWebsocketAuthorization	PUT /conversation/agent/auth	Get agent websocket authorization
getConversation	GET /conversation/conversations/{conversation_uuid}	Retrieve a conversation
getConversationCannedMessages	GET /conversation/canned_messages	Retrieve a list of canned messages ordered by short_code
getConversationContext	PUT /conversation/conversations/{conversation_uuid}/context	Get a webchat conversation context
getConversationDepartmentMemberList	GET /conversation/department_members	Retrieve a list of possible department members
getConversationDepartments	GET /conversation/departments	Retrieve a list of departments ordered by name
getConversationEngagement	GET /conversation/engagements/{conversation_engagement_oid}	Retrieve an engagement
getConversationEngagements	GET /conversation/engagements	Retrieve a list of engagements ordered by name
getConversationMessages	GET /conversation/conversations/{conversation_uuid}/messages/{since}	Retrieve conversation messages
getConversationMultimediaUploadUrl	GET /conversation/upload_url/{extension}	Get a presigned conversation multimedia upload URL
getConversationPbxAudioUploadUrl	GET /conversation/pbx/audio/upload_url/{extension}	Get a pre-signed conversation multimedia upload URL
getConversationPbxCustomerSnapshot	POST /conversation/pbx/customer_snapshot	Get orders and customer information for a phone number
getConversationPermissions	GET /conversation/permissions	Retrieve conversation permissions
getConversationWebchatQueueStatuses	GET /conversation/conversations/queues/statuses	Retrieve a conversation webchat queue statuses
getConversations	GET /conversation/conversations	Retrieve a list of conversation summaries newest to oldest
getConversationsAutocomplete	POST /conversation/conversations/autocomplete	Retrieve a list of matching terms for a search field
getConversationsSearch	POST /conversation/conversations/search	Search conversations
getLocationsForEngagement	POST /conversation/locations	Get location data for engagement configuration
getPbxAgent	GET /conversation/pbx/agent/{conversationPbxAgentUuid}	Get pbx agent
getPbxAgentVoicemail	GET /conversation/pbx/agent/voicemails/{recording_sid}	Get Agent Voicemail
getPbxAgentVoicemails	GET /conversation/pbx/agent/voicemails	Get Agent Voicemails
getPbxAgents	GET /conversation/pbx/agent	Get pbx agents
getPbxAudio	GET /conversation/pbx/audio/{conversationPbxAudioUuid}	Get pbx audio
getPbxAudioUsage	GET /conversation/pbx/audio/{conversationPbxAudioUuid}/usage	Get pbx audio usage
getPbxAudios	GET /conversation/pbx/audio	Get pbx audios
getPbxMenu	GET /conversation/pbx/menu/{conversationPbxMenuUuid}	Get pbx menu
getPbxMenus	GET /conversation/pbx/menu	Get pbx menus
getPbxPhoneNumber	GET /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}	Get pbx phoneNumber
getPbxPhoneNumbers	GET /conversation/pbx/phone_number	Get pbx phoneNumbers
getPbxQueue	GET /conversation/pbx/queue/{conversationPbxQueueUuid}	Get pbx queue
getPbxQueueVoicemail	GET /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}	Get Queue Voicemail
getPbxQueueVoicemails	GET /conversation/pbx/queues/{queue_uuid}/voicemails	Get Queue Voicemails
getPbxQueues	GET /conversation/pbx/queue	Get pbx queues
getPbxTimeBased	GET /conversation/pbx/time_based/{conversationPbxTimeBasedUuid}	Get pbx timeBased
getPbxTimeBaseds	GET /conversation/pbx/time_based	Get pbx timeBaseds
getPbxTimeRange	GET /conversation/pbx/time_range/{conversationPbxTimeRangeUuid}	Get pbx timeRange
getPbxTimeRanges	GET /conversation/pbx/time_range	Get pbx timeRanges
getPbxVoicemailMailbox	GET /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}	Get pbx voicemailMailbox
getPbxVoicemailMailboxes	GET /conversation/pbx/voicemail_mailbox	Get pbx voicemailMailboxes
insertConversationCannedMessage	POST /conversation/canned_messages	Insert a canned message
insertConversationDepartment	POST /conversation/departments	Insert a department
insertConversationEngagement	POST /conversation/engagements	Insert a engagement
insertPbxAudio	POST /conversation/pbx/audio	Insert pbx audio
insertPbxMenu	POST /conversation/pbx/menu	Insert pbx menu
insertPbxQueue	POST /conversation/pbx/queue	Insert pbx queue
insertPbxTimeBased	POST /conversation/pbx/time_based	Insert pbx timeBased
insertPbxTimeRange	POST /conversation/pbx/time_range	Insert pbx timeRange
insertPbxVoicemailMailbox	POST /conversation/pbx/voicemail_mailbox	Insert pbx voicemailMailbox
joinConversation	PUT /conversation/conversations/{conversation_uuid}/join	Join a conversation
leaveConversation	DELETE /conversation/conversations/{conversation_uuid}/leave	Leave a conversation
listenedPbxAgentVoicemail	GET /conversation/pbx/agent/voicemails/{recording_sid}/listened	Listened Agent Voicemail
listenedPbxQueueVoicemail	GET /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened	Listened Queue Voicemail
markReadConversation	PUT /conversation/conversations/{conversation_uuid}/markread	Mark a conversation as read
resetConversationPbxQueueStatistics	POST /conversation/pbx/queues/{queue_uuid}/reset_statistics	reset statistics within the queue
searchConversationCannedMessages	POST /conversation/canned_messages/search	Search for canned messages by short_code
smsUnsubscribeConversation	PUT /conversation/conversations/{conversation_uuid}/sms_unsubscribe	Unsubscribe any SMS participants in this conversation
startConversation	PUT /conversation/conversations	Start a conversation
updateAgentProfile	PUT /conversation/agent/profile	Update agent profile
updateConversationCannedMessage	PUT /conversation/canned_messages/{conversation_canned_message_oid}	Update a canned message
updateConversationDepartment	PUT /conversation/departments/{conversation_department_oid}	Update a department
updateConversationEngagement	PUT /conversation/engagements/{conversation_engagement_oid}	Update a engagement
updateConversationWebchatQueueStatus	PUT /conversation/conversations/queues/{queue_name}/status	Update status within the queue
updatePbxAgent	PUT /conversation/pbx/agent/{conversationPbxAgentUuid}	Update pbx agent
updatePbxAudio	PUT /conversation/pbx/audio/{conversationPbxAudioUuid}	Update pbx audio
updatePbxMenu	PUT /conversation/pbx/menu/{conversationPbxMenuUuid}	Update pbx menu
updatePbxPhoneNumber	PUT /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}	Update pbx phoneNumber
updatePbxQueue	PUT /conversation/pbx/queue/{conversationPbxQueueUuid}	Update pbx queue
updatePbxTimeBased	PUT /conversation/pbx/time_based/{conversationPbxTimeBasedUuid}	Update pbx timeBased
updatePbxTimeRange	PUT /conversation/pbx/time_range/{conversationPbxTimeRangeUuid}	Update pbx timeRange
updatePbxVoicemailMailbox	PUT /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}	Update pbx voicemailMailbox

deleteConversationCannedMessage

deleteConversationCannedMessage($conversation_canned_message_oid)

Delete a conversation canned message

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_canned_message_oid = 56; // int | 

try {
    $apiInstance->deleteConversationCannedMessage($conversation_canned_message_oid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deleteConversationCannedMessage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_canned_message_oid	int

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteDepartment

deleteDepartment($conversation_department_oid)

Delete a conversation department

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_department_oid = 56; // int | 

try {
    $apiInstance->deleteDepartment($conversation_department_oid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deleteDepartment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_department_oid	int

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEngagement

deleteEngagement($conversation_engagement_oid)

Delete a conversation engagement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_engagement_oid = 56; // int | 

try {
    $apiInstance->deleteEngagement($conversation_engagement_oid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deleteEngagement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_engagement_oid	int

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxAgentVoicemail

deletePbxAgentVoicemail($recording_sid)

Delete Agent Voicemail

Delete pbx agent Voicemail

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$recording_sid = "recording_sid_example"; // string | 

try {
    $apiInstance->deletePbxAgentVoicemail($recording_sid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxAgentVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recording_sid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxAudio

\ultracart\v2\models\ConversationPbxAudioResponse deletePbxAudio($conversation_pbx_audio_uuid)

Delete pbx audio

Delete a pbx audio

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_audio_uuid = "conversation_pbx_audio_uuid_example"; // string | 

try {
    $result = $apiInstance->deletePbxAudio($conversation_pbx_audio_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxAudio: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_audio_uuid	string

Return type

\ultracart\v2\models\ConversationPbxAudioResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxMenu

\ultracart\v2\models\ConversationPbxMenuResponse deletePbxMenu($conversation_pbx_menu_uuid)

Delete pbx menu

Delete a pbx menu

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_menu_uuid = "conversation_pbx_menu_uuid_example"; // string | 

try {
    $result = $apiInstance->deletePbxMenu($conversation_pbx_menu_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxMenu: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_menu_uuid	string

Return type

\ultracart\v2\models\ConversationPbxMenuResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxQueue

\ultracart\v2\models\ConversationPbxQueueResponse deletePbxQueue($conversation_pbx_queue_uuid)

Delete pbx queue

Delete a pbx queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_queue_uuid = "conversation_pbx_queue_uuid_example"; // string | 

try {
    $result = $apiInstance->deletePbxQueue($conversation_pbx_queue_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxQueue: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_queue_uuid	string

Return type

\ultracart\v2\models\ConversationPbxQueueResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxQueueVoicemail

deletePbxQueueVoicemail($queue_uuid, $recording_sid)

Delete Queue Voicemail

Delete pbx queue Voicemail

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$queue_uuid = "queue_uuid_example"; // string | 
$recording_sid = "recording_sid_example"; // string | 

try {
    $apiInstance->deletePbxQueueVoicemail($queue_uuid, $recording_sid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxQueueVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
queue_uuid	string
recording_sid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxTimeBased

\ultracart\v2\models\ConversationPbxTimeBasedResponse deletePbxTimeBased($conversation_pbx_time_based_uuid)

Delete pbx timeBased

Delete a pbx timeBased

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_time_based_uuid = "conversation_pbx_time_based_uuid_example"; // string | 

try {
    $result = $apiInstance->deletePbxTimeBased($conversation_pbx_time_based_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxTimeBased: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_time_based_uuid	string

Return type

\ultracart\v2\models\ConversationPbxTimeBasedResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxTimeRange

\ultracart\v2\models\ConversationPbxTimeRangeResponse deletePbxTimeRange($conversation_pbx_time_range_uuid)

Delete pbx timeRange

Delete a pbx timeRange

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_time_range_uuid = "conversation_pbx_time_range_uuid_example"; // string | 

try {
    $result = $apiInstance->deletePbxTimeRange($conversation_pbx_time_range_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxTimeRange: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_time_range_uuid	string

Return type

\ultracart\v2\models\ConversationPbxTimeRangeResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePbxVoicemailMailbox

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse deletePbxVoicemailMailbox($conversation_pbx_voicemail_mailbox_uuid)

Delete pbx voicemailMailbox

Delete a pbx voicemailMailbox

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_voicemail_mailbox_uuid = "conversation_pbx_voicemail_mailbox_uuid_example"; // string | 

try {
    $result = $apiInstance->deletePbxVoicemailMailbox($conversation_pbx_voicemail_mailbox_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->deletePbxVoicemailMailbox: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_voicemail_mailbox_uuid	string

Return type

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAgentKeepAlive

getAgentKeepAlive()

Agent keep alive

Called periodically by the conversation API to keep the session alive.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $apiInstance->getAgentKeepAlive();
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getAgentKeepAlive: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAgentProfile

\ultracart\v2\models\ConversationAgentProfileResponse getAgentProfile()

Get agent profile

Retrieve the agents profile

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getAgentProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getAgentProfile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationAgentProfileResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAgentWebsocketAuthorization

\ultracart\v2\models\ConversationAgentAuthResponse getAgentWebsocketAuthorization()

Get agent websocket authorization

Retrieve a JWT to authorize an agent to make a websocket connection.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getAgentWebsocketAuthorization();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getAgentWebsocketAuthorization: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationAgentAuthResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversation

\ultracart\v2\models\ConversationResponse getConversation($conversation_uuid, $limit)

Retrieve a conversation

Retrieve a conversation including the participants and messages

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getConversation($conversation_uuid, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_uuid	string
limit	int		[optional]

Return type

\ultracart\v2\models\ConversationResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationCannedMessages

\ultracart\v2\models\ConversationCannedMessagesResponse getConversationCannedMessages()

Retrieve a list of canned messages ordered by short_code

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getConversationCannedMessages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationCannedMessages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationCannedMessagesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationContext

\ultracart\v2\models\ConversationWebchatContext getConversationContext($conversation_uuid)

Get a webchat conversation context

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 

try {
    $result = $apiInstance->getConversationContext($conversation_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationContext: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_uuid	string

Return type

\ultracart\v2\models\ConversationWebchatContext

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationDepartmentMemberList

\ultracart\v2\models\ConversationDepartmentMembersResponse getConversationDepartmentMemberList()

Retrieve a list of possible department members

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getConversationDepartmentMemberList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationDepartmentMemberList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationDepartmentMembersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationDepartments

\ultracart\v2\models\ConversationDepartmentsResponse getConversationDepartments()

Retrieve a list of departments ordered by name

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getConversationDepartments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationDepartments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationDepartmentsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationEngagement

\ultracart\v2\models\ConversationEngagementResponse getConversationEngagement($conversation_engagement_oid)

Retrieve an engagement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_engagement_oid = 56; // int | 

try {
    $result = $apiInstance->getConversationEngagement($conversation_engagement_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationEngagement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_engagement_oid	int

Return type

\ultracart\v2\models\ConversationEngagementResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationEngagements

\ultracart\v2\models\ConversationEngagementsResponse getConversationEngagements()

Retrieve a list of engagements ordered by name

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getConversationEngagements();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationEngagements: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationEngagementsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationMessages

\ultracart\v2\models\ConversationMessagesResponse getConversationMessages($conversation_uuid, $since, $limit)

Retrieve conversation messages

Retrieve conversation messages since a particular time

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 
$since = 789; // int | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getConversationMessages($conversation_uuid, $since, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationMessages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
conversation_uuid	string
since	int
limit	int	[optional]

Return type

\ultracart\v2\models\ConversationMessagesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationMultimediaUploadUrl

\ultracart\v2\models\ConversationMultimediaUploadUrlResponse getConversationMultimediaUploadUrl($extension)

Get a presigned conversation multimedia upload URL

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$extension = "extension_example"; // string | 

try {
    $result = $apiInstance->getConversationMultimediaUploadUrl($extension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationMultimediaUploadUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
extension	string

Return type

\ultracart\v2\models\ConversationMultimediaUploadUrlResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationPbxAudioUploadUrl

\ultracart\v2\models\ConversationPbxAudioUploadUrlResponse getConversationPbxAudioUploadUrl($extension)

Get a pre-signed conversation multimedia upload URL

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$extension = "extension_example"; // string | 

try {
    $result = $apiInstance->getConversationPbxAudioUploadUrl($extension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationPbxAudioUploadUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
extension	string

Return type

\ultracart\v2\models\ConversationPbxAudioUploadUrlResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationPbxCustomerSnapshot

\ultracart\v2\models\ConversationPbxCustomerSnapshotResponse getConversationPbxCustomerSnapshot($pbx_customer_snapshot_request)

Get orders and customer information for a phone number

Retrieves all the orders, auto orders, and customer profile for a given phone number

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_customer_snapshot_request = new \ultracart\v2\models\ConversationPbxCustomerSnapshotRequest(); // \ultracart\v2\models\ConversationPbxCustomerSnapshotRequest | Conversation pbx customer snapshot request

try {
    $result = $apiInstance->getConversationPbxCustomerSnapshot($pbx_customer_snapshot_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationPbxCustomerSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_customer_snapshot_request	\ultracart\v2\models\ConversationPbxCustomerSnapshotRequest	Conversation pbx customer snapshot request

Return type

\ultracart\v2\models\ConversationPbxCustomerSnapshotResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationPermissions

\ultracart\v2\models\ConversationPermissionsResponse getConversationPermissions()

Retrieve conversation permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getConversationPermissions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationPermissions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPermissionsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationWebchatQueueStatuses

\ultracart\v2\models\ConversationWebchatQueueStatusesResponse getConversationWebchatQueueStatuses()

Retrieve a conversation webchat queue statuses

Retrieve a conversation webchat queue statuses including agent status and queue entries

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getConversationWebchatQueueStatuses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationWebchatQueueStatuses: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationWebchatQueueStatusesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversations

\ultracart\v2\models\ConversationsResponse getConversations($medium, $before, $_limit, $_offset)

Retrieve a list of conversation summaries newest to oldest

Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$medium = "medium_example"; // string | 
$before = "before_example"; // string | 
$_limit = 100; // int | The maximum number of records to return on this one API call. (Max 200)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.

try {
    $result = $apiInstance->getConversations($medium, $before, $_limit, $_offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
medium	string		[optional]
before	string		[optional]
_limit	int	The maximum number of records to return on this one API call. (Max 200)	[optional] [default to 100]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]

Return type

\ultracart\v2\models\ConversationsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationsAutocomplete

\ultracart\v2\models\ConversationAutocompleteResponse getConversationsAutocomplete($autocomplete_request)

Retrieve a list of matching terms for a search field

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$autocomplete_request = new \ultracart\v2\models\ConversationAutocompleteRequest(); // \ultracart\v2\models\ConversationAutocompleteRequest | Autocomplete Request

try {
    $result = $apiInstance->getConversationsAutocomplete($autocomplete_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationsAutocomplete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
autocomplete_request	\ultracart\v2\models\ConversationAutocompleteRequest	Autocomplete Request

Return type

\ultracart\v2\models\ConversationAutocompleteResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConversationsSearch

\ultracart\v2\models\ConversationSearchResponse getConversationsSearch($search_request)

Search conversations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$search_request = new \ultracart\v2\models\ConversationSearchRequest(); // \ultracart\v2\models\ConversationSearchRequest | Search Request

try {
    $result = $apiInstance->getConversationsSearch($search_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getConversationsSearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
search_request	\ultracart\v2\models\ConversationSearchRequest	Search Request

Return type

\ultracart\v2\models\ConversationSearchResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocationsForEngagement

\ultracart\v2\models\ConversationLocationsResponse getLocationsForEngagement()

Get location data for engagement configuration

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getLocationsForEngagement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getLocationsForEngagement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationLocationsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAgent

\ultracart\v2\models\ConversationPbxAgentResponse getPbxAgent($conversation_pbx_agent_uuid)

Get pbx agent

Retrieve a pbx agent

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_agent_uuid = "conversation_pbx_agent_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxAgent($conversation_pbx_agent_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAgent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_agent_uuid	string

Return type

\ultracart\v2\models\ConversationPbxAgentResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAgentVoicemail

\ultracart\v2\models\ConversationPbxVoicemailMessageResponse getPbxAgentVoicemail($recording_sid)

Get Agent Voicemail

Retrieve pbx agent Voicemail

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$recording_sid = "recording_sid_example"; // string | 

try {
    $result = $apiInstance->getPbxAgentVoicemail($recording_sid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAgentVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recording_sid	string

Return type

\ultracart\v2\models\ConversationPbxVoicemailMessageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAgentVoicemails

\ultracart\v2\models\ConversationPbxVoicemailMessageSummariesResponse getPbxAgentVoicemails()

Get Agent Voicemails

Retrieve pbx agent Voicemails

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxAgentVoicemails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAgentVoicemails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxVoicemailMessageSummariesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAgents

\ultracart\v2\models\ConversationPbxAgentsResponse getPbxAgents()

Get pbx agents

Retrieve pbx agents

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxAgents();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAgents: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxAgentsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAudio

\ultracart\v2\models\ConversationPbxAudioResponse getPbxAudio($conversation_pbx_audio_uuid)

Get pbx audio

Retrieve a pbx audio

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_audio_uuid = "conversation_pbx_audio_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxAudio($conversation_pbx_audio_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAudio: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_audio_uuid	string

Return type

\ultracart\v2\models\ConversationPbxAudioResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAudioUsage

\ultracart\v2\models\ConversationPbxAudioUsageResponse getPbxAudioUsage($conversation_pbx_audio_uuid)

Get pbx audio usage

Retrieve a pbx audio usage

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_audio_uuid = "conversation_pbx_audio_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxAudioUsage($conversation_pbx_audio_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAudioUsage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_audio_uuid	string

Return type

\ultracart\v2\models\ConversationPbxAudioUsageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxAudios

\ultracart\v2\models\ConversationPbxAudiosResponse getPbxAudios()

Get pbx audios

Retrieve pbx audios

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxAudios();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxAudios: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxAudiosResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxMenu

\ultracart\v2\models\ConversationPbxMenuResponse getPbxMenu($conversation_pbx_menu_uuid)

Get pbx menu

Retrieve a pbx menu

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_menu_uuid = "conversation_pbx_menu_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxMenu($conversation_pbx_menu_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxMenu: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_menu_uuid	string

Return type

\ultracart\v2\models\ConversationPbxMenuResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxMenus

\ultracart\v2\models\ConversationPbxMenusResponse getPbxMenus()

Get pbx menus

Retrieve pbx menus

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxMenus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxMenus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxMenusResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxPhoneNumber

\ultracart\v2\models\ConversationPbxPhoneNumberResponse getPbxPhoneNumber($conversation_pbx_phone_number_uuid)

Get pbx phoneNumber

Retrieve a pbx phoneNumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_phone_number_uuid = "conversation_pbx_phone_number_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxPhoneNumber($conversation_pbx_phone_number_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxPhoneNumber: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_phone_number_uuid	string

Return type

\ultracart\v2\models\ConversationPbxPhoneNumberResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxPhoneNumbers

\ultracart\v2\models\ConversationPbxPhoneNumbersResponse getPbxPhoneNumbers()

Get pbx phoneNumbers

Retrieve pbx phoneNumbers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxPhoneNumbers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxPhoneNumbers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxPhoneNumbersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxQueue

\ultracart\v2\models\ConversationPbxQueueResponse getPbxQueue($conversation_pbx_queue_uuid)

Get pbx queue

Retrieve a pbx queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_queue_uuid = "conversation_pbx_queue_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxQueue($conversation_pbx_queue_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxQueue: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_queue_uuid	string

Return type

\ultracart\v2\models\ConversationPbxQueueResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxQueueVoicemail

\ultracart\v2\models\ConversationPbxVoicemailMessageResponse getPbxQueueVoicemail($queue_uuid, $recording_sid)

Get Queue Voicemail

Retrieve pbx queue Voicemail

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$queue_uuid = "queue_uuid_example"; // string | 
$recording_sid = "recording_sid_example"; // string | 

try {
    $result = $apiInstance->getPbxQueueVoicemail($queue_uuid, $recording_sid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxQueueVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
queue_uuid	string
recording_sid	string

Return type

\ultracart\v2\models\ConversationPbxVoicemailMessageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxQueueVoicemails

\ultracart\v2\models\ConversationPbxVoicemailMessageSummariesResponse getPbxQueueVoicemails($queue_uuid)

Get Queue Voicemails

Retrieve pbx queue voicemails

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$queue_uuid = "queue_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxQueueVoicemails($queue_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxQueueVoicemails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
queue_uuid	string

Return type

\ultracart\v2\models\ConversationPbxVoicemailMessageSummariesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxQueues

\ultracart\v2\models\ConversationPbxQueuesResponse getPbxQueues()

Get pbx queues

Retrieve pbx queues

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxQueues();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxQueues: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxQueuesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxTimeBased

\ultracart\v2\models\ConversationPbxTimeBasedResponse getPbxTimeBased($conversation_pbx_time_based_uuid)

Get pbx timeBased

Retrieve a pbx timeBased

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_time_based_uuid = "conversation_pbx_time_based_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxTimeBased($conversation_pbx_time_based_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxTimeBased: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_time_based_uuid	string

Return type

\ultracart\v2\models\ConversationPbxTimeBasedResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxTimeBaseds

\ultracart\v2\models\ConversationPbxTimeBasedsResponse getPbxTimeBaseds()

Get pbx timeBaseds

Retrieve pbx timeBaseds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxTimeBaseds();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxTimeBaseds: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxTimeBasedsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxTimeRange

\ultracart\v2\models\ConversationPbxTimeRangeResponse getPbxTimeRange($conversation_pbx_time_range_uuid)

Get pbx timeRange

Retrieve a pbx timeRange

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_time_range_uuid = "conversation_pbx_time_range_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxTimeRange($conversation_pbx_time_range_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxTimeRange: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_time_range_uuid	string

Return type

\ultracart\v2\models\ConversationPbxTimeRangeResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxTimeRanges

\ultracart\v2\models\ConversationPbxTimeRangesResponse getPbxTimeRanges()

Get pbx timeRanges

Retrieve pbx timeRanges

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxTimeRanges();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxTimeRanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxTimeRangesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxVoicemailMailbox

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse getPbxVoicemailMailbox($conversation_pbx_voicemail_mailbox_uuid)

Get pbx voicemailMailbox

Retrieve a pbx voicemailMailbox

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_voicemail_mailbox_uuid = "conversation_pbx_voicemail_mailbox_uuid_example"; // string | 

try {
    $result = $apiInstance->getPbxVoicemailMailbox($conversation_pbx_voicemail_mailbox_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxVoicemailMailbox: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_voicemail_mailbox_uuid	string

Return type

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPbxVoicemailMailboxes

\ultracart\v2\models\ConversationPbxVoicemailMailboxesResponse getPbxVoicemailMailboxes()

Get pbx voicemailMailboxes

Retrieve pbx voicemailMailboxes

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getPbxVoicemailMailboxes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getPbxVoicemailMailboxes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\ConversationPbxVoicemailMailboxesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertConversationCannedMessage

\ultracart\v2\models\ConversationCannedMessageResponse insertConversationCannedMessage($canned_message)

Insert a canned message

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$canned_message = new \ultracart\v2\models\ConversationCannedMessage(); // \ultracart\v2\models\ConversationCannedMessage | Canned message

try {
    $result = $apiInstance->insertConversationCannedMessage($canned_message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertConversationCannedMessage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
canned_message	\ultracart\v2\models\ConversationCannedMessage	Canned message

Return type

\ultracart\v2\models\ConversationCannedMessageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertConversationDepartment

\ultracart\v2\models\ConversationDepartmentResponse insertConversationDepartment($department)

Insert a department

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$department = new \ultracart\v2\models\ConversationDepartment(); // \ultracart\v2\models\ConversationDepartment | Department

try {
    $result = $apiInstance->insertConversationDepartment($department);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertConversationDepartment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
department	\ultracart\v2\models\ConversationDepartment	Department

Return type

\ultracart\v2\models\ConversationDepartmentResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertConversationEngagement

\ultracart\v2\models\ConversationEngagementResponse insertConversationEngagement($engagement)

Insert a engagement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$engagement = new \ultracart\v2\models\ConversationEngagement(); // \ultracart\v2\models\ConversationEngagement | Engagement

try {
    $result = $apiInstance->insertConversationEngagement($engagement);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertConversationEngagement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
engagement	\ultracart\v2\models\ConversationEngagement	Engagement

Return type

\ultracart\v2\models\ConversationEngagementResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertPbxAudio

\ultracart\v2\models\ConversationPbxAudioResponse insertPbxAudio($pbx_audio)

Insert pbx audio

Insert a pbx audio

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_audio = new \ultracart\v2\models\ConversationPbxAudio(); // \ultracart\v2\models\ConversationPbxAudio | Pbx Audio

try {
    $result = $apiInstance->insertPbxAudio($pbx_audio);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertPbxAudio: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_audio	\ultracart\v2\models\ConversationPbxAudio	Pbx Audio

Return type

\ultracart\v2\models\ConversationPbxAudioResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertPbxMenu

\ultracart\v2\models\ConversationPbxMenuResponse insertPbxMenu($pbx_menu)

Insert pbx menu

Insert a pbx menu

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_menu = new \ultracart\v2\models\ConversationPbxMenu(); // \ultracart\v2\models\ConversationPbxMenu | Pbx Menu

try {
    $result = $apiInstance->insertPbxMenu($pbx_menu);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertPbxMenu: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_menu	\ultracart\v2\models\ConversationPbxMenu	Pbx Menu

Return type

\ultracart\v2\models\ConversationPbxMenuResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertPbxQueue

\ultracart\v2\models\ConversationPbxQueueResponse insertPbxQueue($pbx_queue)

Insert pbx queue

Insert a pbx queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_queue = new \ultracart\v2\models\ConversationPbxQueue(); // \ultracart\v2\models\ConversationPbxQueue | Pbx Queue

try {
    $result = $apiInstance->insertPbxQueue($pbx_queue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertPbxQueue: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_queue	\ultracart\v2\models\ConversationPbxQueue	Pbx Queue

Return type

\ultracart\v2\models\ConversationPbxQueueResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertPbxTimeBased

\ultracart\v2\models\ConversationPbxTimeBasedResponse insertPbxTimeBased($pbx_time_based)

Insert pbx timeBased

Insert a pbx timeBased

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_time_based = new \ultracart\v2\models\ConversationPbxTimeBased(); // \ultracart\v2\models\ConversationPbxTimeBased | Pbx TimeBased

try {
    $result = $apiInstance->insertPbxTimeBased($pbx_time_based);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertPbxTimeBased: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_time_based	\ultracart\v2\models\ConversationPbxTimeBased	Pbx TimeBased

Return type

\ultracart\v2\models\ConversationPbxTimeBasedResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertPbxTimeRange

\ultracart\v2\models\ConversationPbxTimeRangeResponse insertPbxTimeRange($pbx_time_range)

Insert pbx timeRange

Insert a pbx timeRange

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_time_range = new \ultracart\v2\models\ConversationPbxTimeRange(); // \ultracart\v2\models\ConversationPbxTimeRange | Pbx TimeRange

try {
    $result = $apiInstance->insertPbxTimeRange($pbx_time_range);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertPbxTimeRange: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_time_range	\ultracart\v2\models\ConversationPbxTimeRange	Pbx TimeRange

Return type

\ultracart\v2\models\ConversationPbxTimeRangeResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertPbxVoicemailMailbox

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse insertPbxVoicemailMailbox($pbx_voicemail_mailbox)

Insert pbx voicemailMailbox

Insert a pbx voicemailMailbox

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$pbx_voicemail_mailbox = new \ultracart\v2\models\ConversationPbxVoicemailMailbox(); // \ultracart\v2\models\ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox

try {
    $result = $apiInstance->insertPbxVoicemailMailbox($pbx_voicemail_mailbox);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->insertPbxVoicemailMailbox: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pbx_voicemail_mailbox	\ultracart\v2\models\ConversationPbxVoicemailMailbox	Pbx VoicemailMailbox

Return type

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

joinConversation

joinConversation($conversation_uuid, $join_request)

Join a conversation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 
$join_request = new \ultracart\v2\models\ConversationJoinRequest(); // \ultracart\v2\models\ConversationJoinRequest | Join request

try {
    $apiInstance->joinConversation($conversation_uuid, $join_request);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->joinConversation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_uuid	string
join_request	\ultracart\v2\models\ConversationJoinRequest	Join request	[optional]

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leaveConversation

leaveConversation($conversation_uuid)

Leave a conversation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 

try {
    $apiInstance->leaveConversation($conversation_uuid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->leaveConversation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_uuid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listenedPbxAgentVoicemail

listenedPbxAgentVoicemail($recording_sid)

Listened Agent Voicemail

Listened pbx agent Voicemail

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$recording_sid = "recording_sid_example"; // string | 

try {
    $apiInstance->listenedPbxAgentVoicemail($recording_sid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->listenedPbxAgentVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recording_sid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listenedPbxQueueVoicemail

listenedPbxQueueVoicemail($queue_uuid, $recording_sid)

Listened Queue Voicemail

Listened pbx queue Voicemail

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$queue_uuid = "queue_uuid_example"; // string | 
$recording_sid = "recording_sid_example"; // string | 

try {
    $apiInstance->listenedPbxQueueVoicemail($queue_uuid, $recording_sid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->listenedPbxQueueVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
queue_uuid	string
recording_sid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

markReadConversation

markReadConversation($conversation_uuid)

Mark a conversation as read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 

try {
    $apiInstance->markReadConversation($conversation_uuid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->markReadConversation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_uuid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetConversationPbxQueueStatistics

resetConversationPbxQueueStatistics($queue_uuid)

reset statistics within the queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$queue_uuid = "queue_uuid_example"; // string | 

try {
    $apiInstance->resetConversationPbxQueueStatistics($queue_uuid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->resetConversationPbxQueueStatistics: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
queue_uuid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchConversationCannedMessages

\ultracart\v2\models\ConversationCannedMessagesResponse searchConversationCannedMessages($search_request)

Search for canned messages by short_code

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$search_request = new \ultracart\v2\models\ConversationCannedMessagesSearch(); // \ultracart\v2\models\ConversationCannedMessagesSearch | Search request

try {
    $result = $apiInstance->searchConversationCannedMessages($search_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->searchConversationCannedMessages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
search_request	\ultracart\v2\models\ConversationCannedMessagesSearch	Search request

Return type

\ultracart\v2\models\ConversationCannedMessagesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smsUnsubscribeConversation

smsUnsubscribeConversation($conversation_uuid)

Unsubscribe any SMS participants in this conversation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_uuid = "conversation_uuid_example"; // string | 

try {
    $apiInstance->smsUnsubscribeConversation($conversation_uuid);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->smsUnsubscribeConversation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_uuid	string

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startConversation

\ultracart\v2\models\ConversationStartResponse startConversation($start_request)

Start a conversation

Start a new conversation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$start_request = new \ultracart\v2\models\ConversationStartRequest(); // \ultracart\v2\models\ConversationStartRequest | Start request

try {
    $result = $apiInstance->startConversation($start_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->startConversation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
start_request	\ultracart\v2\models\ConversationStartRequest	Start request

Return type

\ultracart\v2\models\ConversationStartResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAgentProfile

\ultracart\v2\models\ConversationAgentProfileResponse updateAgentProfile($profile_request)

Update agent profile

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$profile_request = new \ultracart\v2\models\ConversationAgentProfile(); // \ultracart\v2\models\ConversationAgentProfile | Profile request

try {
    $result = $apiInstance->updateAgentProfile($profile_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updateAgentProfile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
profile_request	\ultracart\v2\models\ConversationAgentProfile	Profile request

Return type

\ultracart\v2\models\ConversationAgentProfileResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConversationCannedMessage

\ultracart\v2\models\ConversationCannedMessageResponse updateConversationCannedMessage($conversation_canned_message_oid, $canned_message)

Update a canned message

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_canned_message_oid = 56; // int | 
$canned_message = new \ultracart\v2\models\ConversationCannedMessage(); // \ultracart\v2\models\ConversationCannedMessage | Canned message

try {
    $result = $apiInstance->updateConversationCannedMessage($conversation_canned_message_oid, $canned_message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updateConversationCannedMessage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_canned_message_oid	int
canned_message	\ultracart\v2\models\ConversationCannedMessage	Canned message

Return type

\ultracart\v2\models\ConversationCannedMessageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConversationDepartment

\ultracart\v2\models\ConversationDepartmentResponse updateConversationDepartment($conversation_department_oid, $department)

Update a department

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_department_oid = 56; // int | 
$department = new \ultracart\v2\models\ConversationDepartment(); // \ultracart\v2\models\ConversationDepartment | Department

try {
    $result = $apiInstance->updateConversationDepartment($conversation_department_oid, $department);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updateConversationDepartment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_department_oid	int
department	\ultracart\v2\models\ConversationDepartment	Department

Return type

\ultracart\v2\models\ConversationDepartmentResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConversationEngagement

\ultracart\v2\models\ConversationEngagementResponse updateConversationEngagement($conversation_engagement_oid, $engagement)

Update a engagement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_engagement_oid = 56; // int | 
$engagement = new \ultracart\v2\models\ConversationEngagement(); // \ultracart\v2\models\ConversationEngagement | Engagement

try {
    $result = $apiInstance->updateConversationEngagement($conversation_engagement_oid, $engagement);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updateConversationEngagement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_engagement_oid	int
engagement	\ultracart\v2\models\ConversationEngagement	Engagement

Return type

\ultracart\v2\models\ConversationEngagementResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateConversationWebchatQueueStatus

updateConversationWebchatQueueStatus($queue_name, $status_request)

Update status within the queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$queue_name = "queue_name_example"; // string | 
$status_request = new \ultracart\v2\models\ConversationWebchatQueueStatusUpdateRequest(); // \ultracart\v2\models\ConversationWebchatQueueStatusUpdateRequest | Status request

try {
    $apiInstance->updateConversationWebchatQueueStatus($queue_name, $status_request);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updateConversationWebchatQueueStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
queue_name	string
status_request	\ultracart\v2\models\ConversationWebchatQueueStatusUpdateRequest	Status request

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxAgent

\ultracart\v2\models\ConversationPbxAgentResponse updatePbxAgent($conversation_pbx_agent_uuid, $pbx_agent)

Update pbx agent

Update a pbx agent

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_agent_uuid = "conversation_pbx_agent_uuid_example"; // string | 
$pbx_agent = new \ultracart\v2\models\ConversationPbxAgent(); // \ultracart\v2\models\ConversationPbxAgent | Pbx Agent

try {
    $result = $apiInstance->updatePbxAgent($conversation_pbx_agent_uuid, $pbx_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxAgent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_agent_uuid	string
pbx_agent	\ultracart\v2\models\ConversationPbxAgent	Pbx Agent

Return type

\ultracart\v2\models\ConversationPbxAgentResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxAudio

\ultracart\v2\models\ConversationPbxAudioResponse updatePbxAudio($conversation_pbx_audio_uuid, $pbx_audio)

Update pbx audio

Update a pbx audio

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_audio_uuid = "conversation_pbx_audio_uuid_example"; // string | 
$pbx_audio = new \ultracart\v2\models\ConversationPbxAudio(); // \ultracart\v2\models\ConversationPbxAudio | Pbx Audio

try {
    $result = $apiInstance->updatePbxAudio($conversation_pbx_audio_uuid, $pbx_audio);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxAudio: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_audio_uuid	string
pbx_audio	\ultracart\v2\models\ConversationPbxAudio	Pbx Audio

Return type

\ultracart\v2\models\ConversationPbxAudioResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxMenu

\ultracart\v2\models\ConversationPbxMenuResponse updatePbxMenu($conversation_pbx_menu_uuid, $pbx_menu)

Update pbx menu

Update a pbx menu

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_menu_uuid = "conversation_pbx_menu_uuid_example"; // string | 
$pbx_menu = new \ultracart\v2\models\ConversationPbxMenu(); // \ultracart\v2\models\ConversationPbxMenu | Pbx Menu

try {
    $result = $apiInstance->updatePbxMenu($conversation_pbx_menu_uuid, $pbx_menu);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxMenu: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_menu_uuid	string
pbx_menu	\ultracart\v2\models\ConversationPbxMenu	Pbx Menu

Return type

\ultracart\v2\models\ConversationPbxMenuResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxPhoneNumber

\ultracart\v2\models\ConversationPbxPhoneNumberResponse updatePbxPhoneNumber($conversation_pbx_phone_number_uuid, $pbx_phone_number)

Update pbx phoneNumber

Update a pbx phoneNumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_phone_number_uuid = "conversation_pbx_phone_number_uuid_example"; // string | 
$pbx_phone_number = new \ultracart\v2\models\ConversationPbxPhoneNumber(); // \ultracart\v2\models\ConversationPbxPhoneNumber | Pbx PhoneNumber

try {
    $result = $apiInstance->updatePbxPhoneNumber($conversation_pbx_phone_number_uuid, $pbx_phone_number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxPhoneNumber: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_phone_number_uuid	string
pbx_phone_number	\ultracart\v2\models\ConversationPbxPhoneNumber	Pbx PhoneNumber

Return type

\ultracart\v2\models\ConversationPbxPhoneNumberResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxQueue

\ultracart\v2\models\ConversationPbxQueueResponse updatePbxQueue($conversation_pbx_queue_uuid, $pbx_queue)

Update pbx queue

Update a pbx queue

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_queue_uuid = "conversation_pbx_queue_uuid_example"; // string | 
$pbx_queue = new \ultracart\v2\models\ConversationPbxQueue(); // \ultracart\v2\models\ConversationPbxQueue | Pbx Queue

try {
    $result = $apiInstance->updatePbxQueue($conversation_pbx_queue_uuid, $pbx_queue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxQueue: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_queue_uuid	string
pbx_queue	\ultracart\v2\models\ConversationPbxQueue	Pbx Queue

Return type

\ultracart\v2\models\ConversationPbxQueueResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxTimeBased

\ultracart\v2\models\ConversationPbxTimeBasedResponse updatePbxTimeBased($conversation_pbx_time_based_uuid, $pbx_time_based)

Update pbx timeBased

Update a pbx timeBased

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_time_based_uuid = "conversation_pbx_time_based_uuid_example"; // string | 
$pbx_time_based = new \ultracart\v2\models\ConversationPbxTimeBased(); // \ultracart\v2\models\ConversationPbxTimeBased | Pbx TimeBased

try {
    $result = $apiInstance->updatePbxTimeBased($conversation_pbx_time_based_uuid, $pbx_time_based);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxTimeBased: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_time_based_uuid	string
pbx_time_based	\ultracart\v2\models\ConversationPbxTimeBased	Pbx TimeBased

Return type

\ultracart\v2\models\ConversationPbxTimeBasedResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxTimeRange

\ultracart\v2\models\ConversationPbxTimeRangeResponse updatePbxTimeRange($conversation_pbx_time_range_uuid, $pbx_time_range)

Update pbx timeRange

Update a pbx timeRange

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_time_range_uuid = "conversation_pbx_time_range_uuid_example"; // string | 
$pbx_time_range = new \ultracart\v2\models\ConversationPbxTimeRange(); // \ultracart\v2\models\ConversationPbxTimeRange | Pbx TimeRange

try {
    $result = $apiInstance->updatePbxTimeRange($conversation_pbx_time_range_uuid, $pbx_time_range);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxTimeRange: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_time_range_uuid	string
pbx_time_range	\ultracart\v2\models\ConversationPbxTimeRange	Pbx TimeRange

Return type

\ultracart\v2\models\ConversationPbxTimeRangeResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePbxVoicemailMailbox

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse updatePbxVoicemailMailbox($conversation_pbx_voicemail_mailbox_uuid, $pbx_voicemail_mailbox)

Update pbx voicemailMailbox

Update a pbx voicemailMailbox

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\ConversationApi::usingApiKey($simple_key);

$conversation_pbx_voicemail_mailbox_uuid = "conversation_pbx_voicemail_mailbox_uuid_example"; // string | 
$pbx_voicemail_mailbox = new \ultracart\v2\models\ConversationPbxVoicemailMailbox(); // \ultracart\v2\models\ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox

try {
    $result = $apiInstance->updatePbxVoicemailMailbox($conversation_pbx_voicemail_mailbox_uuid, $pbx_voicemail_mailbox);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->updatePbxVoicemailMailbox: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_pbx_voicemail_mailbox_uuid	string
pbx_voicemail_mailbox	\ultracart\v2\models\ConversationPbxVoicemailMailbox	Pbx VoicemailMailbox

Return type

\ultracart\v2\models\ConversationPbxVoicemailMailboxResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ConversationApi.md

Latest commit

History

ConversationApi.md

File metadata and controls

ultracart\v2\ConversationApi

deleteConversationCannedMessage

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDepartment

Example

Parameters

Return type

Authorization

HTTP request headers

deleteEngagement

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxAgentVoicemail

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxAudio

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxMenu

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxQueue

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxQueueVoicemail

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxTimeBased

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxTimeRange

Example

Parameters

Return type

Authorization

HTTP request headers

deletePbxVoicemailMailbox

Example

Parameters

Return type

Authorization

HTTP request headers

getAgentKeepAlive

Example

Parameters

Return type

Authorization

HTTP request headers

getAgentProfile