Examples

Last update: 7 days ago by Irais Aguirre

Below are some examples of RCS messages you can send. These examples are only samples; many combinations are possible as long as they follow the indicated structure and rules.

Text message

{
    "agentId": 176,
    "msisdn": "525500000000",
    "message": {
        "text": "RCS message"
    },
    "smsMessage": "SMS message",
    "smsDial": "36232",
    "country": "MX"
}

Image

{
    "agentId": 321,
    "msisdn": "525500000000",
    "message": {
        "contentInfo": {
            "fileUrl": "https://domain.com/image.jpg"
        }
    },
    "smsMessage": "SMS message",
    "smsDial": "26262",
    "country": "MX"
}

Suggested reply

{
    "agentId": 321,
    "msisdn": "525500000000",
    "message": {
        "text": "How do you like your crepes?",
        "suggestions": [
            {
                "reply": {
                    "text": "Sweet",
                    "postbackData": "suggestion_1"
                }
            },
            {
                "reply": {
                    "text": "Savory",
                    "postbackData": "suggestion_2"
                }
            }
        ]
    },
    "smsDial": "26262",
    "smsMessage": "SMS message",
    "country": "MX"
}

View a location

{
    "agentId": 312,
    "msisdn": "525500000000",
    "message": {
        "text": "Sport Gym location",
        "suggestions": [
            {
                "action": {
                    "text": "View location",
                    "postbackData": "1234",
                    "viewLocationAction": {
                        "latLong": {
                            "latitude": 19.4308357,
                            "longitude": -99.1774511
                        },
                        "label": "Sport Gym"
                    }
                }
            }
        ]
    },
    "smsDial": "26262",
    "smsMessage": "SMS message",
    "country": "MX"
}

Share location

{
    "agentId": 343,
    "msisdn": "525500000000",
    "message": {
        "suggestions": [
            {
                "action": {
                    "text": "Share your location",
                    "postbackData": "postback_data_12",
                    "shareLocationAction": {}
                }
            }
        ]
    },
    "smsDial": "26262",
    "smsMessage": "SMS message",
    "country": "MX"
}

Open URL

{
    "agentId": 562,
    "msisdn": "525500000000",
    "message": {
        "text": "Do you need a custom app?",
        "suggestions": [
            {
                "action": {
                    "text": "Your answer is here",
                    "postbackData": "1",
                    "openUrlAction": {
                        "url": "https://www.conceptomovil.com/"
                    }
                }
            }
        ]
    },
    "smsDial": "26262",
    "smsMessage": "SMS message",
    "country": "MX"
}

Standalone Rich Card

{
    "agentId": 456,
    "msisdn": "525500000000",
    "message": {
        "richCard": {
            "standaloneCard": {
                "thumbnailImageAlignment": "RIGHT",
                "cardOrientation": "VERTICAL",
                "cardContent": {
                    "title": "Title",
                    "description": "Card description",
                    "media": {
                        "height": "TALL",
                        "contentInfo": {
                            "fileUrl": "https://domain.com/image.jpg"
                        }
                    },
                    "suggestions": [
                        {
                            "reply": {
                                "text": "Option 1",
                                "postbackData": "suggestion_1"
                            }
                        },
                        {
                            "reply": {
                                "text": "Option 2",
                                "postbackData": "suggestion_2"
                            }
                        }
                    ]
                }
            }
        }
    },
    "smsDial": "26262",
    "smsMessage": "SMS message",
    "country": "MX"
}

Rich Card carousel

{
    "agentId": 642,
    "msisdn": "525500000000",
    "message": {
        "richCard": {
            "carouselCard": {
                "cardWidth": "MEDIUM",
                "cardContents": [
                    {
                        "title": "Card #1",
                        "description": "Card 1 description",
                        "suggestions": [
                            {
                                "reply": {
                                    "text": "Apple",
                                    "postbackData": "card_1"
                                }
                            }
                        ],
                        "media": {
                            "height": "MEDIUM",
                            "contentInfo": {
                                "fileUrl": "https://domain.com/image.jpg"
                            }
                        }
                    },
                    {
                        "title": "Card #2",
                        "description": "Card 2 description",
                        "suggestions": [
                            {
                                "reply": {
                                    "text": "Pear",
                                    "postbackData": "card_2"
                                }
                            }
                        ],
                        "media": {
                            "height": "MEDIUM",
                            "contentInfo": {
                                "fileUrl": "https://domain.com/image.jpg"
                            }
                        }
                    }
                ]
            }
        }
    },
    "smsDial": "26262",
    "smsMessage": "SMS test message",
    "country": "MX"
}

Objects

Response