Create a comment on a portout request

Creates a comment on a portout request.

POST /portouts/{id}/comments

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const comment = await client.portouts.comments.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(comment.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
)
comment = client.portouts.comments.create(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(comment.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"),
	)
	comment, err := client.Portouts.Comments.New(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.PortoutCommentNewParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", comment.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.portouts.comments.CommentCreateParams;
import com.telnyx.sdk.models.portouts.comments.CommentCreateResponse;

public final class Main {
    private Main() {}

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

        CommentCreateResponse comment = client.portouts().comments().create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

require "telnyx"

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

comment = telnyx.portouts.comments.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(comment)

<?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 {
  $comment = $client->portouts->comments->create(
    '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', body: 'body'
  );

  var_dump($comment);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx portouts:comments create \
  --api-key 'My API Key' \
  --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e

curl --request POST \
  --url https://api.telnyx.com/v2/portouts/{id}/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>"
}
'

201

{
  "data": {
    "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "record_type": "portout",
    "body": "This is a comment",
    "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "created_at": "2018-02-02T22:25:27.521Z"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> · required

Portout id

Body

application/json

body · string

Comment to post on this portout request

Response

201

application/json

Portout Comment Response

data · object

Show child attributes

Example:

{
  "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "record_type": "portout",
  "body": "This is a comment",
  "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "created_at": "2018-02-02T22:25:27.521Z"
}