Skip to main content
GET
/
messaging_numbers
/
bulk_updates
/
{order_id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const messagingNumbersBulkUpdate = await client.messagingNumbersBulkUpdates.retrieve('order_id');

console.log(messagingNumbersBulkUpdate.data);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.retrieve(
"order_id",
)
print(messaging_numbers_bulk_update.data)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
messagingNumbersBulkUpdate, err := client.MessagingNumbersBulkUpdates.Get(context.TODO(), "order_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messagingNumbersBulkUpdate.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

MessagingNumbersBulkUpdateRetrieveResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().retrieve("order_id");
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

messaging_numbers_bulk_update = telnyx.messaging_numbers_bulk_updates.retrieve("order_id")

puts(messaging_numbers_bulk_update)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$messagingNumbersBulkUpdate = $client->messagingNumbersBulkUpdates->retrieve(
'order_id'
);

var_dump($messagingNumbersBulkUpdate);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx messaging-numbers-bulk-updates retrieve \
--api-key 'My API Key' \
--order-id order_id
curl --request GET \
--url https://api.telnyx.com/v2/messaging_numbers/bulk_updates/{order_id} \
--header 'Authorization: Bearer <token>'
{
  "data": {
    "record_type": "messaging_numbers_bulk_update",
    "order_id": "00000000-0000-0000-0000-000000000000",
    "success": [
      "+18880000000",
      "+18880000001",
      "+18880000002"
    ],
    "pending": [],
    "failed": []
  }
}
{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

order_id
string
required

Order ID to verify bulk update status.

Response

Successful response with details about messaging bulk update phone numbers.

data
object
Example:
{
"record_type": "messaging_numbers_bulk_update",
"order_id": "00000000-0000-0000-0000-000000000000",
"success": [
"+18880000000",
"+18880000001",
"+18880000002"
],
"pending": [],
"failed": []
}