Messages API – Error Responses

This topic provides information about various error responses for the RCS Messages REST APIs.

It includes the following sections:

Response Error Codes for Messages

The following table lists the response error codes for the Messages API:

Code	HTTP Status Code	Type	Description (response message returned by the API).
1200	200	Success	Message Sent Successfully to provider.
1400	400	INVALID_REQUEST	Validation error (field length exceeded, invalid structure, or incorrect values).
1400	400	INVALID_REQUEST	Invalid URL provided in request (media, file, or thumbnail URLs must be valid HTTP/HTTPS URLs).
1400	400	INVALID_REQUEST	Array size limits exceeded (carousel cards, suggestions count).
1400	400	INVALID_FIELD_FORMAT	Invalid JSON in request body.
1400	400	MISSING_REQUIRED_FIELD	Missing required field in request.
1405	405	INVALID_REQUEST	Only POST is allowed on this endpoint.
1417	400	INVALID_NUMBER	Invalid number.
1419	400	INVALID_SERVICE_CODE	Invalid service code.
1420	400	INVALID_TTL	Invalid TTL (time-to-live) value.
1423	400	CHANNEL_UNSUPPORTED	RCS is not enabled for this subscriber profile

Sample Responses

The following are the sample responses:

{
    "code": "1200",
    "message": "Message Sent Successfully to provider",
    "data": {
        "to": "recipient number",
        "messageId": "message id"
    },
    "error": {}
  }

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardStandalone.content.title: Cannot have more than 200 characters, but has 202.",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardStandalone.content.title: Cannot have more than 200 characters, but has 202."
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardStandalone.content.description: Cannot have more than 2000 characters, but has 2003(exact count).",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardStandalone.content.description: Cannot have more than 2000 characters, but has 2003(exact count)."
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardStandalone.content.suggestion[0].reply.text: Cannot have more than 25 characters, but has 27(exact count).",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardStandalone.content.suggestion[0].reply.text: Cannot have more than 25 characters, but has 27(exact count)."
    }
  }
}

  {
  "code": 1400,
  "message": "Request invalid: Path $.richCardStandalone.content.suggestion[0].reply.text: Cannot have more than 2000 characters, but has 2002(exact count).",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardStandalone.content.suggestion[0].reply.text: Cannot have more than 2000 characters, but has 2002(exact count)."
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardStandalone.content.media.fileUrl: is not a valid URL: test1.jpg",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardStandalone.content.media.fileUrl: is not a valid URL: test1.jpg"
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.file.fileUrl: is not a valid URL: test.mp4",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.file.fileUrl: is not a valid URL: test.mp4"
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.file.fileUrl: is not a valid URL: /d21eXXXXXhv.cloudfront.net/1775XXXXXX72-MicrosoftTeams-video_(7).pdf",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.file.fileUrl: is not a valid URL: /d21eXXXXXh6.cloudfront.net/17XXXXXXXX75-MicrosoftTeams-video_(7).pdf"
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.file.fileUrl: is not a valid URL: ftp://i.pinimg.com/originals/f8/3a/8f/f83a8f819c257d3499fa4fa58e.jpg",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.file.fileUrl: is not a valid URL: ftp://i.pinimg.com/originals/f8/3a/8f/f83a8f819c2XXXXXXXXXX5758e.jpg"
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardCarousel.cardContent[]: This array must have between 2 and 10 elements, but has 11.",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardCarousel.cardContent[]: This array must have between 2 and 10 elements, but has 11."
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardCarousel.cardContent[1].media.fileUrl: is not a valid URL: /736x/bb/6b/4c/bb6b4c083e6a53a45cfc1e17244b.jpg",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardCarousel.cardContent[1].media.fileUrl: is not a valid URL: /736x/bb/6b/4c/bb6b4c083eXXXXXXXXXX6a53a45b.jpg"
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardCarousel.cardContent[1].media.file.thumbnailUrl: is not a valid URL: /736x/bb/6b/4c/bb6b4cXXXXXXXX083e61e17244b.jpg",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardCarousel.cardContent[1].media.file.thumbnailUrl: is not a valid URL: /736x/bb/6b/4c/bb6b4cXXXXXXXXXX083e6a53a45b.jpg"
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.suggestions: This array cannot have more than 11 elements, but has 12.",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.suggestions: This array cannot have more than 11 elements, but has 12."
    }
  }
}

{
  "code": 1400,
  "message": "Request invalid: Path $.richCardCarousel.cardContent[3].suggestions: This array cannot have more than 4 elements, but has 5.",
  "data": {
    "error": {
      "error_code": "INVALID_REQUEST",
      "error_message": "Request invalid: Path $.richCardCarousel.cardContent[3].suggestions: This array cannot have more than 4 elements, but has 5."
    }
  }
}

{
    "code": "1419",
    "data": {},
    "error": {
        "error_code": "INVALID_SERVICE_CODE",
        "error_message": "Invalid service code."
    },
    "message": "Invalid service code."
}

  {
    "code": "1417",
    "data": {},
    "error": {
        "error_code": "INVALID_NUMBER",
        "error_message": "Invalid number."
    },
    "message": "Invalid number."
}

{
  "code": 1400,
  "message": "Invalid JSON in request body",
  "data": {},
    "error": {
      "error_code": "INVALID_FIELD_FORMAT",
      "error_message": "message"
    }
  }
}

{
  "code": 1400,
  "message": "Missing required field in request",
  "data": {},
    "error": {
      "error_code": "MISSING_REQUIRED_FIELD",
      "error_message": "Missing fields are required"
    }
  }
}

{
  "code": "1417",
  "message": "Invalid number.",
  "data": {},
    "error": {
      "error_code": "INVALID_NUMBER",
      "error_message": "Invalid number."
    }
  }
}

{
  "code": "1420",
  "message": "Invalid ttl.",
  "data": {},
    "error": {
      "error_code": "INVALID_TTL",
      "error_message": "Invalid ttl."
    }
  }
}

{
  "code": "1423",
  "message": "RCS is not enabled for this subscriber profile.",
  "data": {},
  "error": {
    "error_code": "CHANNEL_UNSUPPORTED",
    "error_message": "RCS is not enabled for this subscriber profile."
  }
}

{
    "code": "1405",
    "message": "Only POST is allowed on this endpoint",
    "data": {},
    "error": {
        "error_code": "INVALID_REQUEST",
        "error_message": "use HTTP POST"
    }
}

{
    "code": "1400",
    "data": {},
    "error": {
        "error_code": "INVALID_REQUEST",
        "error_message": "Request invalid: Path '$.text': Cannot have more than 2000 characters, but has 2268."
    },
    "message": "Request invalid: Path '$.text': Cannot have more than 2000 characters, but has 2268."
}

{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "body": "Incorrect SID or API key.",
        "error": "record not found"
    }
}

Updated 2 days ago