Sinch Contact Structure
Documentation of the contact data structure in the Sinch Conversation API
Type: object
Properties: 0
CommunicationsMessagingSMSVoiceVerificationCPaaS
Sinch Contact Structure is a JSON Structure definition published by Sinch.
Meta-schema:
JSON Structure
{
"title": "Sinch Contact Structure",
"description": "Documentation of the contact data structure in the Sinch Conversation API",
"type": "object",
"fields": [
{
"name": "id",
"type": "string",
"required": true,
"description": "Unique contact identifier assigned by Sinch"
},
{
"name": "channel_identities",
"type": "array",
"required": true,
"description": "List of channel-specific identities for this contact"
},
{
"name": "channel_identities[].channel",
"type": "enum",
"required": true,
"values": ["SMS", "RCS", "WHATSAPP", "MESSENGER", "INSTAGRAM", "VIBER", "TELEGRAM", "KAKAOTALK", "LINE"],
"description": "The messaging channel"
},
{
"name": "channel_identities[].identity",
"type": "string",
"required": true,
"description": "Channel-specific identity (e.g., phone number for SMS)"
},
{
"name": "display_name",
"type": "string",
"required": false,
"description": "Human-readable display name for the contact"
},
{
"name": "email",
"type": "string",
"required": false,
"description": "Contact email address"
},
{
"name": "external_id",
"type": "string",
"required": false,
"description": "External system identifier for the contact"
},
{
"name": "metadata",
"type": "string",
"required": false,
"description": "Custom metadata string for the contact"
}
]
}