string anumber_contact_name

This is the Contact Name assigned to the Telephone Number (CLI) and Address Book entry which are manually entered or assigned from an Inbound Call. If you don’t have a Contact assigned to the Inbound CLI, this field defaults to “-”.

string bnumber

The TTNC number that's being called.

array bnumber_tags

This will contain all TAGS associated with the TTNC Number and will show in this format [ “tag1" , “tag2” ]. If you don’t have any TAGS set up, this field defaults to [ ].

string bnumber_alias

This is the Alias or Nickname of the TTNC Number. If you don’t have a Number Alias or Nickname set up, this field defaults to “-”.

string call_date

The date of the start of the call.

string call_time

The time of the start of the call.

string ref

The CDR Ref for the call - this can be used after the call has finished to identify the call. CDRs can be pulled using the TTNC API by using NoveroCDR requests.

string option

If you have Virtual Receptionist (menu option based forwarding) enabled on your number then this is the position in the call flow. Webhooks need to be set up on each option in order to be triggered. Virtual Receptionist examples:

• "-" : The caller has reached the Top level of the Virtual Receptionist

• "2" : The caller has reached Option 2 of the Virtual Receptionist

• "2,1" : The caller has reached Sub Option 1 of Option 2 of the Virtual Receptionist (pressed 2, then 1)

If you have no Virtual Receptionist set up, this field defaults to "-".

string event_type

The type of webhook.

string call_date

The date of the start of the call.

string call_time

The time of the start of the call.

string anumber

The telephone number of the caller.

string anumber_type

The location or network of the caller.

string anumber_contact_name

This is the Contact Name assigned to the Telephone Number (CLI) and Address Book entry which are manually entered or assigned from an Inbound Call. If you don’t have a Contact assigned to the Inbound CLI, this field defaults to “-”.

string bnumber

The TTNC number that's being called.

string bnumber_type

The location or type of TTNC number being called.

array bnumber_tags

This will contain all TAGS associated with the TTNC Number and will show in this format [ “tag1" , “tag2” ]. If you don’t have any TAGS set up, this field defaults to [ ].

string bnumber_alias

This is the Alias or Nickname of the TTNC Number. If you don’t have a Number Alias or Nickname set up, this field defaults to “-”.

string dialled

The telephone number of the forwarding destination which answered the call.

string dialled_type

The location or network of the forwarding destination which answered the call.

string duration

The duration of the call which was connected to the forwarding destination.

string duration_system

The duration of the call which was connected to TTNC services (Virtual Receptionist, Call Greeting, etc).

float cost

The amount of call credit deducted from your account to pay for the call (ex VAT).

string reason

The clearing code for the call. Reason 1 means a completed call, for other reasons codes, please contact support.

string reason_q805

Additional clearing code for the call. Reason 1 means a completed call, for other reasons codes, please contact support.

string event_type

The type of webhook.

1

Call completed successfully

6

Termination during dial code resolution

7

Termination during number entry

8

Carrier not accepting call

12

Caller Hung Up in Voice Response

1000

Unspecified reason for end of call

1001

Number busy

1002

No answer

1003

Number unobtainable

1004

Number changed

1005

Out of order

1006

Incoming calls barred

1007

Call rejected

1008

Call failed

1009

Channel busy

1010

No channels

1011

Congestion

1012

Unexpected

1015

Caller aborted call or hung up when ringing

1016

Destination restricted

1017

Channel limit reached

1018

Destination is blacklisted

1019

Caller hung up in queue

string originator

The telephone number of the sender.

string bnumber

The TTNC telephone number the SMS was sent to.

string sms_date

The date that SMS was sent.

string sms_time

The time that SMS was sent.

int message_id

The unique identifier for the SMS.

string message

The content of the SMS.

string udh optional

"User Data Header" is binary structure which determines extra information about the SMS message. This is usually present when the SMS is part of a larger message which was over the 160 character limit for a single SMS. The UDH information will allow you to be able to rejoin the SMSs into the larger message if you desired. In order to determine which SMSs are related to each other in this way you must look at the last 6 characters of the UDH.

For the example; "0500035D0302" you take the last 6 characters "5D0302" and split these into the pairs "5D", "03" "02".

• The first pairing ("5D") is a reference, and will be the same between all SMSs which should be joined (this is not a unique identifier, purely a common reference).

• The second pairing ("03") is the total number of SMSs which make up the entire messages, in this case, there are 3 messages.

• The final pairing ("02") is the index of the SMS in the larger message, meaning this is the second part of the message.

We can infer that there is a "0500035D0201" for the first part of the message, and a "0500035D0203" for the last part of the message

int call_api_vkey_id optional

The ID of the application (obtained from NoveroVKeys::ListApplications) to be used for the webhook. To disassociate any application from the webhook set this parameter to -1. The Application for the set ID must have a Webhook URL associated with it. The 'call_api_vkey_id' webhook relates to Webhooks for inbound calls.

int sms_api_vkey_id optional

The ID of the application (obtained from NoveroVKeys::ListApplications) to be used for the webhook. To disassociate any application from the webhook set this parameter to -1. The Application for the set ID must have a Webhook URL associated with it. The 'sms_api_vkey_id' webhook relates to Webhooks for inbound SMS.