API Data Dictionary

Common Fields

Field NameData TypeExamplesNotes
EventName
STRING
MsgEvent, CallEvent, ApplicationExitEvent, DtmfEvent
The type of event represented by this record.
EventVersion
INTEGER
1An integer used for data format versioning.
EventSku
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
TimeStamp
TIMESTAMP
YYYY-DD-MM HH:MM:SS UTC
A timestamp field common to all EventTypes.
HostId
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
CustomerId
STRING
10001234
Customer Identifier assigned by IntelePeer.
CustomerName
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
Originator
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
OriginatorId
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
FlowId
STRING
5e8367f36426c01425fbd1f5
The unique identifier of the SmartFlow associated with a record.
FlowName
STRING
My Cool Smartflow
The name of the SmartFlow associated with a record.
ActionId
STRING
END_CALL, TRANSFER_2
The type of the ActionID in the associated SmartFlow that generated this record.
ActionName
STRING
EndCall, Transfer, SMS, Dial
The name of the ActionId in the associated Smartflow that generated this record.
IsTriggerAction
BOOLEAN
TRUE/FALSE
When TRUE, represents the triggering of a new Smartflow instance (Session)
SessionId
STRING
1586552213-1022008-SR-000-0000000000000-031F68BD
A field containing a unique ID that can be used to correlate all events that occurred during a given SmartFlow session.
TransactionId
STRING
CP1-1586552223-0011L00002Z0ZUN-0004FB32C
A Unique ID for the specific execution of the application record.
ApplicationRegion
STRING
UNK, US:US, US:US-CA, ES:EU
What CPaaS Region the Smartflow executed in
* UNK = Unknown
* US:US = USA
* US:US-CA = California
* US:EU = European
PassthroughVersion
INTEGER
N/A
Not yet implemented, currently returns an empty string for all events.
Passthrough
STRING
N/A
Not yet implemented, currently returns an empty string for all events.

CallEvent

Field NameData TypeExamplesNotes
IsOutboundFromCust

BOOLEAN
TRUE/FALSE

This indicates whether this call is being placed (TRUE) by the customer or received (FALSE) by the customer.

CallingNumber

STRING
+13031234567
The number placing this call in E.164 format.
CallingNumberCountry

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
CallingNumberState

STRING
N/A
Not yet implemented, currently returns an empty string for all events.

CallingNumberCity
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
CallingNumberRegion
STRING
N/A
Not yet implemented, currently returns an empty string for all events.

CalledNumber
STRING
+13031234567

The number receiving the call in E.164 format.
CalledNumberCountry

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
CalledNumberState
STRING
N/A
Not yet implemented, currently returns an empty string for all events.
CalledNumberRegion

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
CallOfferTime
TIMESTAMP
YYYY-DD-MM HH:MM:SS UTC

The time when Call is offered to the network.
CallAnswerTime

TIMESTAMP

YYYY-DD-MM HH:MM:SS UTC
The time when call is answered.
CallEndTime

TIMESTAMP

YYYY-DD-MM HH:MM:SS UTC

The time when call is ended.
CallDuration
INTEGER

94
The duration of the call, in seconds.
CallAnswerIndicator
STRING
ANSWER, ATTEMPT
This indicates that the call was answered when it has the value 'ANSWER' or that there was no answer when the value is 'ATTEMPT'.
CallVoiceMailDetected
BOOLEAN

TRUE/FALSE
This indicates that the SmartFlow detected a voicemail system on the remote end when the value is TRUE otherwise the value is FALSE.
CallDisconnectReason

STRING
* REJECTED
* HANGUP
* HUNGUP
* BUSY
* REMOTE_RING
* ANSWER
* CONGESTION
* UNKNOWN
* VM
* NOANSWER
* ANSWER_CHANNEL_COMPLETE
* CHANUNAVAIL
This indicates the reason a call ended regardless of whether it was answered or not.

* US:US = USA
* US:US-CA = California
* US:EU = European
CallDisconnectInitator

INTEGER
0, 1

This indicates that a call was disconnected because the SmartFlow reached a 'Hang Up' ActionId when the value is 0, or for any other reason when the value is 1.

MsgEvent

Field NameData TypeExamplesNotes
IsOutboundFromCust


BOOLEAN
TRUE/FALSE

* TRUE = Customer of IntelePeer is sending the Message
* FALSE = Customer of IntelePeer is receiving the Message

Channel
STRING
SMS, WAPP, FB
Indicates which type of Message was sent.
* WAPP = WhatsApp
* FB = Facebook
* SMS = SMS
SendingId


STRING
1-27221, +13031234567, 104822724348630, d68af5e7685089098242db10
Depends on direction of Message (IsOutboundFromCust) and Channel
* Channel = SMS
* Inbound (IsOutboundFromCust = FALSE) = E.164 format
* Outbound (IsOutboundFromCust = TRUE) = Customer Code in E.164 or hyphened Short Code
* Channel = WAPP
* Inbound = Authorization ID
* Outbound = E.164 Number
* Channel = FB
* Inbound = Facebook Page ID
* Outbound = Facebook PSID, ID of conversion between Page and User.
SendingCountry


STRING
N/A
Not yet implemented, currently returns an empty string for all events.

SendingState

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
SendingCity

STRING
N/A
Not yet implemented, currently returns an empty string for all events.

SendingRegion
STRING
N/A

Not yet implemented, currently returns an empty string for all events.
SentId
STRING
1-27221, +13031234567, 104822724348630, d68af5e7685089098242db10
Depends on direction of Message (IsOutboundFromCust) and Channel
* Channel = SMS
* Outbound (IsOutboundFromCust = FALSE) = E.164 format
* Inbound (IsOutboundFromCust = TRUE) = Customer Code in E.164 or hyphened Short Code
* Channel = WAPP
* Outbound = Authorization ID
* Inbound = E.164 Number
* Channel = FB
* Outbound = Facebook Page ID
* Inbound = Facebook PSID, ID of conversion between Page and User.
SentCountry

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
SentState

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
SentCity

STRINGN/A
Not yet implemented, currently returns an empty string for all events.
SentRegion

STRING

N/ANot yet implemented, currently returns an empty string for all events.
FileReferenceType

STRING
N/A
Not yet implemented, currently returns an empty string for all events.
FileReference

STRING

N/A
Not yet implemented, currently returns an empty string for all events.
NetworkFragments

INTEGER

3

This field contains the number of fragments the message was broken into and is only populated when the message is an SMS message.
RawMessageSize

INTEGER

326
This field indicates the number of Characters in the message, independent of encoding.

ApplicationExitEvent

Field NameData TypeExamplesNotes
StartTime



TIMESTAMP

YYYY-DD-MM HH:MM:SS UTC


This field indicates when the SmartFlow began execution.
Channel
TIMESTAMP

YYYY-DD-MM HH:MM:SS UTC
This field indicates when the SmartFlow ended execution.
Path



STRING
ICALL_1;EXTCALL_30;COND_37;END_CALL;
This field indicates the ActionId(s) executed in the Smartflow seperated by semi-colons.
ExitReason



STRING
END_CALL

This field shows which SmartFlow ActionId ended the flow and is set to TrxLoop when a loop is detected and broken.

DtmfEvent

Field NameData TypeExamplesNotes
DtmfInput




INTEGER


3261957, -1



This field contains the input digits concatenated together as a numerical value or -1 representing an invalid input.
DtmfSource

STRING


keypad
This field indicates how the DTMF input was captured.

ErrorReason




STRING
N/A

Not yet implemented, currently returns an empty string for all events.

ApiEvent

Field NameData TypeExamplesNotes
IsOutboundFromCust





BOOLEAN



TRUE/FALSE



This field indicates that the SmartFlow was triggered by an API call when it is set to TRUE.