package
0.26.0
Repository: https://github.com/twilio/twilio-go.git
Documentation: pkg.go.dev

# README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.29.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://messaging.twilio.com

ClassMethodHTTP requestDescription
A2pBrandRegistrationsApiCreateBrandRegistrationsPost /v1/a2p/BrandRegistrations
A2pBrandRegistrationsApiFetchBrandRegistrationsGet /v1/a2p/BrandRegistrations/{Sid}
A2pBrandRegistrationsApiListBrandRegistrationsGet /v1/a2p/BrandRegistrations
A2pBrandRegistrationsApiUpdateBrandRegistrationsPost /v1/a2p/BrandRegistrations/{Sid}
A2pBrandRegistrationsVettingsApiCreateBrandVettingPost /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
A2pBrandRegistrationsVettingsApiFetchBrandVettingGet /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}
A2pBrandRegistrationsVettingsApiListBrandVettingGet /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
DeactivationsApiFetchDeactivationGet /v1/Deactivations
ServicesApiCreateServicePost /v1/Services
ServicesApiDeleteServiceDelete /v1/Services/{Sid}
ServicesApiFetchServiceGet /v1/Services/{Sid}
ServicesApiListServiceGet /v1/Services
ServicesApiUpdateServicePost /v1/Services/{Sid}
ServicesAlphaSendersApiCreateAlphaSenderPost /v1/Services/{ServiceSid}/AlphaSenders
ServicesAlphaSendersApiDeleteAlphaSenderDelete /v1/Services/{ServiceSid}/AlphaSenders/{Sid}
ServicesAlphaSendersApiFetchAlphaSenderGet /v1/Services/{ServiceSid}/AlphaSenders/{Sid}
ServicesAlphaSendersApiListAlphaSenderGet /v1/Services/{ServiceSid}/AlphaSenders
ServicesComplianceUsa2pApiCreateUsAppToPersonPost /v1/Services/{MessagingServiceSid}/Compliance/Usa2p
ServicesComplianceUsa2pApiDeleteUsAppToPersonDelete /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
ServicesComplianceUsa2pApiFetchUsAppToPersonGet /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
ServicesComplianceUsa2pApiListUsAppToPersonGet /v1/Services/{MessagingServiceSid}/Compliance/Usa2p
ServicesComplianceUsa2pUsecasesApiFetchUsAppToPersonUsecaseGet /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases
ServicesPhoneNumbersApiCreatePhoneNumberPost /v1/Services/{ServiceSid}/PhoneNumbers
ServicesPhoneNumbersApiDeletePhoneNumberDelete /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
ServicesPhoneNumbersApiFetchPhoneNumberGet /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
ServicesPhoneNumbersApiListPhoneNumberGet /v1/Services/{ServiceSid}/PhoneNumbers
ServicesPreregisteredUsa2pApiCreateExternalCampaignPost /v1/Services/PreregisteredUsa2p
ServicesShortCodesApiCreateShortCodePost /v1/Services/{ServiceSid}/ShortCodes
ServicesShortCodesApiDeleteShortCodeDelete /v1/Services/{ServiceSid}/ShortCodes/{Sid}
ServicesShortCodesApiFetchShortCodeGet /v1/Services/{ServiceSid}/ShortCodes/{Sid}
ServicesShortCodesApiListShortCodeGet /v1/Services/{ServiceSid}/ShortCodes
ServicesUsecasesApiFetchUsecaseGet /v1/Services/Usecases

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

# Functions

No description provided by the author
No description provided by the author

# Structs

No description provided by the author
Optional parameters for the method 'CreateAlphaSender'.
Optional parameters for the method 'CreateBrandRegistrations'.
Optional parameters for the method 'CreateBrandVetting'.
Optional parameters for the method 'CreateExternalCampaign'.
Optional parameters for the method 'CreatePhoneNumber'.
Optional parameters for the method 'CreateService'.
Optional parameters for the method 'CreateShortCode'.
Optional parameters for the method 'CreateUsAppToPerson'.
Optional parameters for the method 'FetchDeactivation'.
Optional parameters for the method 'FetchUsAppToPersonUsecase'.
Optional parameters for the method 'ListAlphaSender'.
ListAlphaSenderResponse struct for ListAlphaSenderResponse.
Optional parameters for the method 'ListBrandRegistrations'.
ListBrandRegistrationsResponse struct for ListBrandRegistrationsResponse.
Optional parameters for the method 'ListBrandVetting'.
ListBrandVettingResponse struct for ListBrandVettingResponse.
Optional parameters for the method 'ListPhoneNumber'.
ListPhoneNumberResponse struct for ListPhoneNumberResponse.
Optional parameters for the method 'ListService'.
ListServiceResponse struct for ListServiceResponse.
ListServiceResponseMeta struct for ListServiceResponseMeta.
Optional parameters for the method 'ListShortCode'.
ListShortCodeResponse struct for ListShortCodeResponse.
Optional parameters for the method 'ListUsAppToPerson'.
ListUsAppToPersonResponse struct for ListUsAppToPersonResponse.
MessagingV1AlphaSender struct for MessagingV1AlphaSender.
MessagingV1BrandRegistrations struct for MessagingV1BrandRegistrations.
MessagingV1BrandVetting struct for MessagingV1BrandVetting.
MessagingV1Deactivation struct for MessagingV1Deactivation.
MessagingV1ExternalCampaign struct for MessagingV1ExternalCampaign.
MessagingV1PhoneNumber struct for MessagingV1PhoneNumber.
MessagingV1Service struct for MessagingV1Service.
MessagingV1ShortCode struct for MessagingV1ShortCode.
MessagingV1UsAppToPerson struct for MessagingV1UsAppToPerson.
MessagingV1UsAppToPersonUsecase struct for MessagingV1UsAppToPersonUsecase.
MessagingV1Usecase struct for MessagingV1Usecase.
Optional parameters for the method 'UpdateService'.