Sample code for 30+ languages & platforms
Visual FoxPro Requires Chilkat v11.6.0+

Sinch Engage: Find Available Dedicated Numbers

See more Sinch Engage Examples

Search available number inventory by country and SMS capability, then follow continuation tokens. These are numbers available for assignment, not necessarily numbers owned by your account. Browsing does not purchase or assign a number. Country, number-type, registration requirements, and account permissions determine availability.

Sinch Engage is the renamed MessageMedia platform. This uses the Engage API, not Sinch Conversation API credentials or endpoints. Create an Engage API key/secret and place {"api_key":"YOUR_KEY","api_secret":"YOUR_SECRET"} in private sinch-engage.json. Select the account's regional HTTPS host: https://au.app.api.sinch.com, https://eu.app.api.sinch.com, or https://us.app.api.sinch.com. Basic authentication here means the API key/secret over verified TLS. Do not ship account credentials in a public mobile, browser, or desktop application.

Transport success and API success are checked separately. On HTTP 429, honor Retry-After before a bounded retry. Check account permissions and regional credentials for 401/403. A timeout or 5xx response after submitting a write can leave its outcome uncertain: reconcile before retrying, especially sends and resource creation. Metadata is correlation data, not an idempotency key. Inspect error bodies privately because they can contain phone numbers and message content.

Sinch Engage API reference

Chilkat Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loConfig
LOCAL lcApiHost
LOCAL loHttp
LOCAL loUrl
LOCAL loResp
LOCAL loResult
LOCAL lcNextToken
LOCAL loSeenTokens
LOCAL lnPageCount
LOCAL i

lnSuccess = 0

*  Assumes Chilkat is unlocked. See Global Unlock Sample.

*  Store real credentials in private configuration, never in distributed client code.
loConfig = CreateObject('Chilkat.JsonObject')
loConfig.Strict = 1
lnSuccess = loConfig.LoadFile("sinch-engage.json")
IF (lnSuccess <> 1) THEN
    ? "Could not load private sinch-engage.json."
    RELEASE loConfig
    CANCEL
ENDIF

IF ((loConfig.JsonTypeOf("api_key") <> 1) OR (loConfig.StringOfEquals("api_key","",1) = 1) OR (loConfig.JsonTypeOf("api_secret") <> 1) OR (loConfig.StringOfEquals("api_secret","",1) = 1)) THEN
    ? "The private configuration must contain api_key and api_secret."
    RELEASE loConfig
    CANCEL
ENDIF

*  Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
lcApiHost = "https://au.app.api.sinch.com"
loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.FollowRedirects = 0
loHttp.ConnectTimeout = 20
loHttp.ReadTimeout = 30
loHttp.Login = loConfig.StringOf("api_key")
loHttp.Password = loConfig.StringOf("api_secret")
loHttp.BasicAuth = 1
loHttp.SetRequestHeader("Accept","application/json")
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loResult = CreateObject('Chilkat.JsonObject')
loResult.Strict = 1
lcNextToken = ""
loSeenTokens = CreateObject('Chilkat.StringArray')
lnPageCount = 0
DO WHILE (lnPageCount < 100)
    loUrl.Clear()
    loUrl.Append(lcApiHost)
    loUrl.Append("/v1/messaging/numbers/dedicated?country=AU&service_types=SMS&page_size=50")
    IF (lcNextToken <> "") THEN
        loUrl.Append("&token=")
        loUrl.Append(loHttp.UrlEncode(lcNextToken))
    ENDIF

    lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
    *  HttpJson/HttpNoBody also return false for HTTP 4xx/5xx responses.
    IF ((lnSuccess <> 1) AND (loResp.StatusCode = 0)) THEN
        ? "HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write."
        RELEASE loConfig
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loResult
        RELEASE loSeenTokens
        CANCEL
    ENDIF

    IF ((loResp.StatusCode <> 200)) THEN
        ? "Unexpected HTTP status: " + STR(loResp.StatusCode)
        IF (loResp.StatusCode = 429) THEN
            ? "Retry-After: " + loResp.GetHeaderField("Retry-After")
        ENDIF

        RELEASE loConfig
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loResult
        RELEASE loSeenTokens
        CANCEL
    ENDIF

    lnSuccess = loResult.Load(loResp.BodyStr)
    IF (lnSuccess <> 1) THEN
        ? "Expected a JSON response."
        RELEASE loConfig
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loResult
        RELEASE loSeenTokens
        CANCEL
    ENDIF

    IF (loResult.SizeOfArray("data") < 0) THEN
        ? "Expected an array in the response."
        RELEASE loConfig
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loResult
        RELEASE loSeenTokens
        CANCEL
    ENDIF

    i = 0
    DO WHILE (i < loResult.SizeOfArray("data"))
        loResult.I = i
        ? "Available number ID: " + loResult.StringOf("data[i].id")
        ? "Number: " + loResult.StringOf("data[i].phone_number")
        i = i + 1
    ENDDO
    lnPageCount = lnPageCount + 1
    lcNextToken = ""
    IF (loResult.JsonTypeOf("pagination.next_token") = 1) THEN
        lcNextToken = loResult.StringOf("pagination.next_token")
    ENDIF

    IF (lcNextToken = "") THEN
        ? "Completed pages: " + STR(lnPageCount)
        RELEASE loConfig
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loResult
        RELEASE loSeenTokens
        CANCEL
    ENDIF

    IF (loSeenTokens.Find(lcNextToken,0) >= 0) THEN
        ? "Repeated pagination token; stopping to avoid a loop."
        RELEASE loConfig
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loResult
        RELEASE loSeenTokens
        CANCEL
    ENDIF

    loSeenTokens.Append(lcNextToken)
ENDDO
? "Stopped at the example's 100-page limit. Save the continuation token to resume."

RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loSeenTokens