Incomplete information for send_messages

[ramon-san]

Describe the issue

I am using the send_messages function for Pinpoint (this docs) and the information is hard to understand and not complete.

Here are a couple of the issues I've encountered with the docs:

• In all the MessageConfiguration values an Action option is DEEP_LINKS. However, nowhere does the documentation mention how the routes are ought to be passed.
• In the MessageConfiguration for GCMMessage you mention a possible value is IconReference, but you don't mention how to format this value. Here is what confuses me: "does this have to be a route, a file name, if it is a file name where should the file be located?"

As a whole, I believe the documentation for this function is somewhat lacking. Would appreciate it if you could explain some areas in more depth.

Links

Docs send_messages

[tim-finnigan]

Thanks for reaching out and sharing this feedback. The documentation for the send_messages command comes from the upstream SendMessages API documentation. Improvements to this documentation would need to be made by the Pinpoint team, and any updates should be automatically reflected in the SDK documentation. We generally recommend using the Provide feedback links at the bottom of those API reference pages in order to share feedback directly with the appropriate team. (We can also forward feedback internally to service teams like Pinpoint.)

Also have you looked through the Pinpoint Developer Guide? I found this page on sending messages: https://docs.aws.amazon.com/pinpoint/latest/developerguide/send-messages-sms.html. Maybe more information could be added to that guide in order to help with use cases like the one you described.

For passing routes, it looks like you add that to the Headers array per the documentation:

A header can contain information such as the sender, receiver, route, or timestamp.

More info on message routes can be found here: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-limitations-routes.html. Regarding IconReference I think that should just reference the file name path. Have you tried that or run into any issues?

[ramon-san]

Hi @tim-finnigan thanks for the reply.

I already used the "Provide feedback" link you shared and explained the improvements the documentation requires. Thanks for sharing so many resources, the sending messages documentation you shared is for SMS and not mobile notifications which is what I am trying to solve. There is a big difference between both functionalities, but the resources are great. Will let you know if I receive a reply from the Pinpoint team on the issue I raised through the documentation website, but it would be great if you also forwarded this issue to them.

I will be working on improving my notification flows this week and will inform you if I figure out how to make some of the functionality I'm trying to create. Will attempt to figure out the correct API request structure through trial and error, which is inefficient and wasteful, but the only solution given the incomplete documentation.