ContactPointOttSvc

Represents a contact point for an over-the-top (OTT) messaging service, such as WhatsApp. This object is available in API version 68.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
ActiveFromDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time the contact point OTT service becomes active.
ActiveToDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time the contact point OTT service stops being active.
BestTimeToContactEndTime
Type
time
Properties
Create, Filter, Nillable, Sort, Update
Description
The end of the best time window to contact the contact point OTT service.
BestTimeToContactStartTime
Type
time
Properties
Create, Filter, Nillable, Sort, Update
Description
The start of the best time window to contact the contact point OTT service.
BestTimeToContactTimeZone
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Time zone used to determine the best time to contact the contact point OTT service.
BusinessPortfolioIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Meta Business Manager ID (BMID) for WhatsApp. Also called the Meta Business Portfolio.
ChannelCodeSender
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique identifier of the channel sending messages.
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country where the contact point OTT service is located.
EngagementChannelTypeId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the associated engagement channel type record.
This is a relationship field.
Relationship Name
EngagementChannelType
Relationship Type
Lookup
Refers To
EngagementChannelType
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Whether the contact point OTT service is the primary contact. The default value is false.
IsUndeliverable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Whether the contact point OTT service is undeliverable. The default value is false.
IsVerified
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Whether the contact point OTT service is verified. The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
The name of the contact point OTT service record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user or group that owns this record.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ParentId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the parent record.
This is a polymorphic relationship field.
Relationship Name
Parent
Relationship Type
Lookup
Refers To
Account, Contact, Individual, Lead
PhoneNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The phone number of the contact point OTT service.
PreferenceRank
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The rank of this contact point OTT service among the preferred methods of contact.
ProfileFirstCreatedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the contact point OTT service profile was first created.
ProfileLastUpdatedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the contact point OTT service profile was last updated.
ProfileOccurrenceCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of profile occurrences for the contact point OTT service record.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The usage type for the contact point OTT service.
Possible values are:
  • Home
  • Inactive
  • Temporary
  • Work
UserIdentifier
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The identifier that the messaging platform assigns to this contact point OTT service account.
UserName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unique identifier for the user’s account.