line_automatic_calls

Creates, updates, deletes, gets or lists a line_automatic_calls resource.

Overview

Name	line_automatic_calls
Type	Resource
Id	ovh.telephony.line_automatic_calls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
answer_datetime	string (date-time)	answer date (wire: answerDatetime)
application	string	Application and dialplan running for call
application_result	string	end status of application (wire: applicationResult)
billing_number	string (phone-number)	billingNumber (service used) (wire: billingNumber)
call_created_datetime	string (date-time)	creation date of the call (wire: callCreatedDatetime)
call_duration	integer	call duration on seconds (wire: callDuration)
callee	string (phone-number)	number called
caller	string (phone-number)	number where the call come from
dtmf	string	DTMF received during the call separate by commas
hangup_cause	string	hangup cause (AccessInformationDiscarded, AllottedTimeout, AttendedTransfer, BlindTransfer, CallAwardedbeing, ChannelTypeNotImplemented, ChannelUnacceptable, CodeSip403BearerCapabilityNotAuthorized, CodeSip403IncomingCallsBarred, CodeSip403OutgoingCallsBarred, CodeSip404NoRouteToDestination, CodeSip404NoRouteToSpecifiedTransitNetwork, CodeSip404UnallocatedNumber, CodeSip408NoUserResponding, CodeSip410NumberChanged, CodeSip410RedirectionToNewDestination, CodeSip480NoAnswerFromUser, CodeSip480NormalUnspecified, CodeSip480SubscriberAbsent, CodeSip483ExchangeRoutingError, CodeSip484InvalidNumberFormatAddressIncomplete, CodeSip486UserBusy, CodeSip487OriginatorCancel, CodeSip488IncompatibleDestination, CodeSip488bearerCapabilityNotImplemented, CodeSip501FacilitiesRejected, CodeSip501RequestedFacilityNotImplemented, CodeSip501ServiceOrOptionNotImplementedUnspecified, CodeSip502DestinationOutOfOrder, CodeSip503BearerCapabilityNotPresentlyAvailable, CodeSip503NetworkOutOfOrder, CodeSip503NoCircuitChannelAvailable, CodeSip503RequestedCircuitOrChannelNotAvailable, CodeSip503SwitchingEquipmentCongestion, CodeSip503TemporaryFailure, CodeSip504RecoveryOnTimerExpiry, CodeSip603CallRejected, Crash, GatewayDown, InformationElementOrParameterNonExistentOrNotImplemented, InterworkingUnspecified, InvalidCallReferenceValue, InvalidInformationElementContents, InvalidMessageUnspecified, LoseRace, ManagerRequest, MandatoryInformationElementIsMissing, MediaTimeout, MessageNotCompatibleWithCallState, MessageNotCompatibleWithCallStateOrMessageTypeNonExistentOrNotImplemented, MessageTypeNonExistentOrNotImplemented, NormalCallClearing, ParameterNonExistentOrNotImplementedPassedOnNationalUse, PickedOff, PreEmpted, ProgressTimeout, ProtocolErrorUnspecified, RequestedFacilityNotSubscribed, ResponseToStatusInquiry, ServiceOrOptionNotAvailableUnspecified, SystemShutdown, UnknownOrCallUnfinished, UnspecifiedNoOtherCauseCodesApplicable, UserChallenge, UserNotRegistered) (wire: hangupCause)
hangup_datetime	string (date-time)	hangup date (wire: hangupDatetime)
identifier	string	Generated call identifier
transfer_from	string	original call uuid if it's a transfer (wire: transferFrom)
uuid	string	unique call id

list

Automatic Call made by Call Generator on this line

Name	Datatype	Description
answer_datetime	string (date-time)	answer date (wire: answerDatetime)
application	string	Application and dialplan running for call
application_result	string	end status of application (wire: applicationResult)
billing_number	string (phone-number)	billingNumber (service used) (wire: billingNumber)
call_created_datetime	string (date-time)	creation date of the call (wire: callCreatedDatetime)
call_duration	integer	call duration on seconds (wire: callDuration)
callee	string (phone-number)	number called
caller	string (phone-number)	number where the call come from
dtmf	string	DTMF received during the call separate by commas
hangup_cause	string	hangup cause (AccessInformationDiscarded, AllottedTimeout, AttendedTransfer, BlindTransfer, CallAwardedbeing, ChannelTypeNotImplemented, ChannelUnacceptable, CodeSip403BearerCapabilityNotAuthorized, CodeSip403IncomingCallsBarred, CodeSip403OutgoingCallsBarred, CodeSip404NoRouteToDestination, CodeSip404NoRouteToSpecifiedTransitNetwork, CodeSip404UnallocatedNumber, CodeSip408NoUserResponding, CodeSip410NumberChanged, CodeSip410RedirectionToNewDestination, CodeSip480NoAnswerFromUser, CodeSip480NormalUnspecified, CodeSip480SubscriberAbsent, CodeSip483ExchangeRoutingError, CodeSip484InvalidNumberFormatAddressIncomplete, CodeSip486UserBusy, CodeSip487OriginatorCancel, CodeSip488IncompatibleDestination, CodeSip488bearerCapabilityNotImplemented, CodeSip501FacilitiesRejected, CodeSip501RequestedFacilityNotImplemented, CodeSip501ServiceOrOptionNotImplementedUnspecified, CodeSip502DestinationOutOfOrder, CodeSip503BearerCapabilityNotPresentlyAvailable, CodeSip503NetworkOutOfOrder, CodeSip503NoCircuitChannelAvailable, CodeSip503RequestedCircuitOrChannelNotAvailable, CodeSip503SwitchingEquipmentCongestion, CodeSip503TemporaryFailure, CodeSip504RecoveryOnTimerExpiry, CodeSip603CallRejected, Crash, GatewayDown, InformationElementOrParameterNonExistentOrNotImplemented, InterworkingUnspecified, InvalidCallReferenceValue, InvalidInformationElementContents, InvalidMessageUnspecified, LoseRace, ManagerRequest, MandatoryInformationElementIsMissing, MediaTimeout, MessageNotCompatibleWithCallState, MessageNotCompatibleWithCallStateOrMessageTypeNonExistentOrNotImplemented, MessageTypeNonExistentOrNotImplemented, NormalCallClearing, ParameterNonExistentOrNotImplementedPassedOnNationalUse, PickedOff, PreEmpted, ProgressTimeout, ProtocolErrorUnspecified, RequestedFacilityNotSubscribed, ResponseToStatusInquiry, ServiceOrOptionNotAvailableUnspecified, SystemShutdown, UnknownOrCallUnfinished, UnspecifiedNoOtherCauseCodesApplicable, UserChallenge, UserNotRegistered) (wire: hangupCause)
hangup_datetime	string (date-time)	hangup date (wire: hangupDatetime)
identifier	string	Generated call identifier
transfer_from	string	original call uuid if it's a transfer (wire: transferFrom)
uuid	string	unique call id

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, identifier, service_name		Get an automatic call
list	select	billing_account, service_name	x_pagination_mode	List automatic calls
create	insert	billing_account, service_name, called_number, dialplan, is_anonymous		Make an automatic call

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
identifier	string	Generated call identifier
service_name	string	(wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get an automatic call

SELECT
answer_datetime,
application,
application_result,
billing_number,
call_created_datetime,
call_duration,
callee,
caller,
dtmf,
hangup_cause,
hangup_datetime,
identifier,
transfer_from,
uuid
FROM ovh.telephony.line_automatic_calls
WHERE billing_account = '{{ billing_account }}' -- required
AND identifier = '{{ identifier }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List automatic calls

SELECT
answer_datetime,
application,
application_result,
billing_number,
call_created_datetime,
call_duration,
callee,
caller,
dtmf,
hangup_cause,
hangup_datetime,
identifier,
transfer_from,
uuid
FROM ovh.telephony.line_automatic_calls
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Make an automatic call

INSERT INTO ovh.telephony.line_automatic_calls (
bridge_number_dialplan,
called_number,
calling_number,
dialplan,
is_anonymous,
playback_audio_file_dialplan,
timeout,
tts_text_dialplan,
billing_account,
service_name
)
SELECT 
'{{ bridge_number_dialplan }}',
'{{ called_number }}' /* required */,
'{{ calling_number }}',
'{{ dialplan }}' /* required */,
{{ is_anonymous }} /* required */,
'{{ playback_audio_file_dialplan }}',
{{ timeout }},
'{{ tts_text_dialplan }}',
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: line_automatic_calls
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the line_automatic_calls resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the line_automatic_calls resource.
  - name: bridge_number_dialplan
    value: "{{ bridge_number_dialplan }}"
    description: |
      Phone number
  - name: called_number
    value: "{{ called_number }}"
    description: |
      Phone number
  - name: calling_number
    value: "{{ calling_number }}"
    description: |
      Phone number
  - name: dialplan
    value: "{{ dialplan }}"
    description: |
      Dialplan used for the call
    valid_values: ['ReadText', 'RequestAppointmentConfirmation', 'RequestAppointmentConfirmationWithTransfer']
  - name: is_anonymous
    value: {{ is_anonymous }}
    description: |
      For anonymous call
  - name: playback_audio_file_dialplan
    value: "{{ playback_audio_file_dialplan }}"
    description: |
      Name of the audioFile (if needed) with extention. This audio file must have been upload previously
  - name: timeout
    value: {{ timeout }}
    description: |
      Timeout (in seconds). Default is 20 seconds
  - name: tts_text_dialplan
    value: "{{ tts_text_dialplan }}"
    description: |
      Text to read if TTS on dialplan selected