Send a Message

POST

https://api.smobi.com/v1/message

POST

/v1/message

1 curl -X POST 'https://api.smobi.com/v1/message' \
2   -H 'x-api-key: your-api-key' \
3   -H 'Content-Type: application/json' \
4   -d '{
5     "clientRef": "61efac14-961c-4070-a369-04e16578e86f",
6     "recipientPhoneNumber": "15552223333",
7     "content": {
8       "rcs": {
9         "content": {
10           "type": "RICH_CARD",
11           "item": { 
12             "title": "Blue Cotton T-Shirt",
13             "description": "Premium comfort with style. Available in S-XL sizes.",
14             "mediaUrl": "https://smobi-public-templates.s3.us-east-1.amazonaws.com/public/products/Product7.png",
15             "orientation": "VERTICAL",
16             "thumbnailPosition": "RIGHT",
17             "height": "SHORT",
18             "localSuggestions": []
19           },
20           "globalSuggestions": [
21             {
22               "id": "reply-1",
23               "text": "Reply to message",
24               "type": "REPLY"
25             },
26             {
27               "id": "url-1",
28               "text": "Visit our website",
29               "type": "OPEN_URL",
30               "url": "https://example.com"
31             },
32             {
33               "id": "phone-1",
34               "text": "Call support",
35               "type": "DIAL_PHONE",
36               "phoneNumber": "+12223334444"
37             },
38             {
39               "id": "location-1",
40               "text": "Show location",
41               "type": "SHOW_LOCATION",
42               "latitude": "37.7749",
43               "longitude": "-122.4194",
44               "label": "San Francisco"
45             }
46           ]
47         }
48       },
49       "sms": {
50         "content": "Check out our Blue Cotton T-Shirt! View it here: https://example.com/products/blue-tshirt. Need help? Reply to this message.",
51         "mediaUrl": "https://smobi-public-templates.s3.us-east-1.amazonaws.com/public/products/Product7.png"
52       }
53     }
54   }'

Try it

200Successful

1 {
2   "status": "PROCESSING",
3   "smobiMessageId": "123e4567-e89b-12d3-a456-426614174000"
4 }

Headers

x-api-keystringRequired

Request

This endpoint expects an object.

clientRefstringRequired

Client reference ID

recipientPhoneNumberstringRequired

Recipient phone number, string of all digits, for example, 12223334444

contentobjectRequired

Message content

Response

Message sent successfully

statusstring

Status of the message processing

smobiMessageIdstring

Unique identifier for the message in Smobi system

Headers

Request

Response

Errors