Message cache

Read and delete cached inbound SMS messages from leased numbers.

The cache stores inbound SMS messages for leased numbers when caching is enabled.

Only messages received after the cache was enabled are stored.

Configure the cache in the portal under Numbers / SMS Numbers → 3. Forward received SMS (optional).

Fetch the next message

Use Api/Cache/GetNextMessage to read the oldest cached message.

If you omit MobileNumber, the service returns the oldest message across all leased numbers on the account.

Parameter	Type	Description
UserName	Required	Username
Password	Required	Password
MobileNumber	Optional	Leased SMS number in international or national format

Examples:

/Api/Cache/GetNextMessage?Username=xxx&Password=yyy
/Api/Cache/GetNextMessage?Username=xxx&Password=yyy&MobileNumber=[phone]

Response structure

<IncomingSMS>
  <Result>
    <ResultCode></ResultCode>
    <ResultText></ResultText>
  </Result>
  <MessageID></MessageID>
  <SMS>
    <Message></Message>
    <AddressTo></AddressTo>
    <AddressFrom></AddressFrom>
    <TimeStamp></TimeStamp>
  </SMS>
</IncomingSMS>

If the cache is empty, the service returns result code 11204. The <SMS> and <MessageID> nodes are omitted.

Delete a cached message

Use Api/Cache/DeleteMessage to remove a cached message after processing it.

This only deletes the cached copy. The message stays visible under Received Messages.

Parameter	Type	Description
UserName	Required	Username
Password	Required	Password
MessageID	Required	Message ID returned by GetNextMessage

Example:

/Api/Cache/DeleteMessage?UserName=xxx&Password=yyy&MessageID=123abc

Delete response

<DeleteMsg>
  <Result>
    <ResultCode></ResultCode>
    <ResultText></ResultText>
  </Result>
</DeleteMsg>