Deeplinks

• Create Deeplink POST /deeplinks

• Create iMessage Deeplink POST /deeplinks/imessage

Create Deeplink

post

This feature is currently in closed beta. Please contact your MTA account rep or MTA support for more information.

Request Body

• androidURI: The deeplink URI for Android.

• iosURI: The deeplink URI for iOS.

• macURI: The deeplink URI for Mac.

• windowsURI: The deeplink URI for Windows.

• defaultURI: The default deeplink URI.

Response

Upon successful creation, the response will include the deeplinkUrl

Example

Request:

{
  "androidURI": "sms:[phone]?body=Example",
  "iosURI": "imessage://[e-mail]?body=Example",
  "macURI": "https://mobile-text-alerts.com/example",
  "windowsURI": "https://mobile-text-alerts.com/example",
  "defaultURI": "https://mobile-text-alerts.com/example"
}

Response:

{
  "deeplinkUrl": "https://platform.mobile-text-alerts.com/deeplinks/abc"
}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

androidURIstringRequired

iosURIstringRequired

macURIstringRequired

windowsURIstringRequired

defaultURIstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

post/deeplinks

POST /v3/deeplinks HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "androidURI": "text",
  "iosURI": "text",
  "macURI": "text",
  "windowsURI": "text",
  "defaultURI": "text"
}

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "deeplinkUrl": "text"
  }
}

Create IMessage Deeplink

post

This feature is currently in closed beta. Please contact your MTA account rep or MTA support for more information.

Request Body

• longcodeId: The id of the longcode.

• optInMessage: The opt-in message used to populate the deeplink urls.

• senderName: The sender name used to pre-populate the "To:" field for iMessage

  • If this field is empty, the sender name associated with the longcode will be used as the default.

Response

Upon successful creation, the response will include the deeplinkUrl

Example

Request:

{
  "longcodeId": 1337,
  "optInMessage": "Example",
  "senderName": "[e-mail]"
}

Response:

{
  "deeplinkUrl": "https://platform.mobile-text-alerts.com/deeplinks/abc"
}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

longcodeIdnumberOptional

optInMessagestringRequired

senderNamestringOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

post/deeplinks/imessage

POST /v3/deeplinks/imessage HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "longcodeId": 1,
  "optInMessage": "text",
  "senderName": "text"
}

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "deeplinkUrl": "text"
  }
}