RCS - Outgoing

Send RCS carousel rich card messages

post/v4/rcs/outgoing/carousel

Request

  • Base URL: https://api.inmobile.com
  • URL: https://api.inmobile.com/v4/rcs/outgoing/carousel
  • Auth: one of:
    • HTTP basic
    • API key in query parameter apikey

Request body

Example request

{
  "messages": [
    {
      "to": "4512345678",
      "countryHint": "45",
      "agentId": "65a53287-862b-44dd-afed-0e7aef22a688",
      "messageTrafficType": 4,
      "messageId": "PetShop",
      "respectBlacklist": true,
      "validityPeriodInSeconds": 90,
      "msisdnCooldownInMinutes": 1440,
      "webhooks": {
        "statusCallbackUrl": "https://[your_domain]/your/desired/path",
        "readCallbackUrl": "https://[your_domain]/your/desired/path"
      },
      "suggestions": [
        {
          "reply": {
            "text": "This is text",
            "postbackData": "eyJ0eXBlIjowfQ=="
          }
        }
      ],
      "cardWidth": 1,
      "carouselCards": [
        {
          "title": "Card Title",
          "description": "This is a description of the card content",
          "suggestions": [
            {
              "reply": {
                "text": "Yes",
                "postbackData": "WUVTX1NFTEVDVEVE"
              }
            },
            {
              "action": {
                "text": "Call us",
                "postbackData": "Q0FMTF9TRUxFQ1RFRA==",
                "dialAction": {
                  "to": "4512345678",
                  "countryHint": "45"
                }
              }
            },
            {
              "action": {
                "text": "Open website",
                "postbackData": "T1BFTl9XRUJTSVRF",
                "openUrlAction": {
                  "url": "https://www.inmobile.com",
                  "application": 1
                }
              }
            },
            {
              "action": {
                "text": "Show location",
                "postbackData": "U0hPV19MT0NBVElPTg==",
                "viewLocationAction": {
                  "latitude": 55.6761,
                  "longitude": 12.5683
                }
              }
            }
          ],
          "media": {
            "height": 2,
            "contentInfo": {
              "fileUrl": "https://example.inmobile.com/12345678-1234-1234-1234-123456789012/file.jpg",
              "thumbnailUrl": "https://example.inmobile.com/12345678-1234-1234-1234-123456789012/thumbnail.jpg"
            }
          }
        }
      ]
    }
  ]
}

Response

Example response

{
  "results": [
    {
      "numberDetails": {
        "countryCode": "45",
        "phoneNumber": "12345678",
        "rawMsisdn": "45 12 34 56 78",
        "msisdn": "4512345678",
        "isValidMsisdn": true,
        "countryHint": "45"
      },
      "agentId": "foo-123-bar",
      "messageId": "PetShop"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.