Package com.sinch.sdk.domains.conversation.models.v1

Interface ChannelIdentity

public interface ChannelIdentity

A unique identity of message recipient on a particular channel. For example, the channel identity on SMS, WHATSAPP or VIBERBM is a MSISDN phone number.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChannelIdentity.Builder	Dedicated Builder

Method Summary

Modifier and Type	Method	Description
static ChannelIdentity.Builder	builder()	Getting builder
String	getAppId()	Required if using a channel that uses app-scoped channel identities.
ConversationChannel	getChannel()	Get channel
String	getIdentity()	The channel identity.

Method Details

getAppId

String getAppId()

Required if using a channel that uses app-scoped channel identities. Currently, FB Messenger, Viber Bot, Instagram, Apple Messages for Business, LINE, and WeChat use app-scoped channel identities, which means contacts will have different channel identities on different Conversation API apps. These can be thought of as virtual identities that are app-specific and, therefore, the app_id must be included in the API call.

Returns:

appId

getChannel

ConversationChannel getChannel()

Get channel

Returns:

channel

getIdentity

String getIdentity()

The channel identity. This will differ from channel to channel. For example, a phone number for SMS, WhatsApp, and Viber Business.

Returns:

identity

builder

static ChannelIdentity.Builder builder()

Getting builder

Returns:

New Builder instance