Description
The digital messaging team will address an inconsistency with the Instagram messaging channel.
In this documentation, you can see that the NormalizedPayload.From.channel.nickname is set to “User name”. However, in the other related messaging channels, we use the following
-
Normalized Payload From channel.nickname = “User handle”
-
Normalized Payload From channel.firstName = “User display name” (which is same thing as “User name” for Instagram)
The change here is to make Instagram work in the same way, to provide consistency and reduce customer confusion and support tickets. After this change we should see the following (and the above linked developer center docs would be updated at that time as well) for Instagram.
Normalized Payload
From
channel.from.id |
channel.from.idType |
channel.from.image |
channel.from.firstName |
channel.from.lastName |
channel.nickname |
channel.from.email |
channel.from.additionalIds |
|---|---|---|---|---|---|---|---|
| User page scoped id | Opaque | User name | User handle |
To
channel.to.id |
channel.to.nickname |
channel.to.idType |
channel.to.additionalIds |
|---|---|---|---|
| Integration.id | Integration.name | Opaque |
Conversation address payload
From
fromAddress.name |
fromAddress.addressNormalized |
fromAddress.addressRaw |
fromAddress.addressDisplayable |
|---|---|---|---|
| User name | User page scoped id | User page scoped id | User handle |
To
toAdress.name |
toAddress.addressNormalized |
toAddress.addressRaw |
toAddress.addressDisplayable |
|---|---|---|---|
| Integration.name | Integration.id |
Change Category
API
Change Context
This change is for platform consistency and reduce customer confusion when using Instagram messaging.
Change Impact
For Instagram digital messaging, customer identifier field is being changed slightly. In the Normalized message payload we are making channel.from.nickname == Instagram User handle
channel.from.firstName == Instagram User name.
No data is being lost in this change, only a slight adjustment to the normalized message fields to provide consistency. The Conversation model fields will not have any changes, other than the addition of user handle
Date of Change
Feb 03, 2025
Impacted APIs
GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
GET /api/v2/conversations/messages/{messageId}/details
References
[PURE-6150]
[MSG-6581]