v1

package
v1.10.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 10, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SmsService_SendTextFromSubscriber_FullMethodName = "/wgtwo.sms.v1.SmsService/SendTextFromSubscriber"
	SmsService_SendTextToSubscriber_FullMethodName   = "/wgtwo.sms.v1.SmsService/SendTextToSubscriber"
	SmsService_SendDataToSubscriber_FullMethodName   = "/wgtwo.sms.v1.SmsService/SendDataToSubscriber"
)

Variables

View Source
var (
	MessageClass_name = map[int32]string{
		0: "MESSAGE_CLASS_UNSPECIFIED",
		1: "MESSAGE_CLASS_FLASH_MESSAGE",
		2: "MESSAGE_CLASS_ME_SPECIFIC",
		3: "MESSAGE_CLASS_SIM_SPECIFIC",
		4: "MESSAGE_CLASS_TE_SPECIFIC",
	}
	MessageClass_value = map[string]int32{
		"MESSAGE_CLASS_UNSPECIFIED":   0,
		"MESSAGE_CLASS_FLASH_MESSAGE": 1,
		"MESSAGE_CLASS_ME_SPECIFIC":   2,
		"MESSAGE_CLASS_SIM_SPECIFIC":  3,
		"MESSAGE_CLASS_TE_SPECIFIC":   4,
	}
)

Enum value maps for MessageClass.

View Source
var (
	SendMessageResponse_SendStatus_name = map[int32]string{
		0: "SEND_STATUS_UNSPECIFIED",
		1: "SEND_STATUS_OK",
		2: "SEND_STATUS_REJECT",
		3: "SEND_STATUS_ERROR",
	}
	SendMessageResponse_SendStatus_value = map[string]int32{
		"SEND_STATUS_UNSPECIFIED": 0,
		"SEND_STATUS_OK":          1,
		"SEND_STATUS_REJECT":      2,
		"SEND_STATUS_ERROR":       3,
	}
)

Enum value maps for SendMessageResponse_SendStatus.

View Source
var File_wgtwo_sms_v1_sms_proto protoreflect.FileDescriptor
View Source
var SmsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "wgtwo.sms.v1.SmsService",
	HandlerType: (*SmsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SendTextFromSubscriber",
			Handler:    _SmsService_SendTextFromSubscriber_Handler,
		},
		{
			MethodName: "SendTextToSubscriber",
			Handler:    _SmsService_SendTextToSubscriber_Handler,
		},
		{
			MethodName: "SendDataToSubscriber",
			Handler:    _SmsService_SendDataToSubscriber_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "wgtwo/sms/v1/sms.proto",
}

SmsService_ServiceDesc is the grpc.ServiceDesc for SmsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSmsServiceServer

func RegisterSmsServiceServer(s grpc.ServiceRegistrar, srv SmsServiceServer)

Types

type ApplicationPort

type ApplicationPort struct {

	// The originator application port.
	OriginatorPort uint32 `protobuf:"varint,1,opt,name=originator_port,json=originatorPort,proto3" json:"originator_port,omitempty"`
	// The destination application port.
	DestinationPort uint32 `protobuf:"varint,2,opt,name=destination_port,json=destinationPort,proto3" json:"destination_port,omitempty"`
	// contains filtered or unexported fields
}

Application ports are used to send data SMS messages to specific applications on the handset. If a reply to the message is sent, it should use the same ports but swap originator and destination port numbers.

func (*ApplicationPort) Descriptor deprecated

func (*ApplicationPort) Descriptor() ([]byte, []int)

Deprecated: Use ApplicationPort.ProtoReflect.Descriptor instead.

func (*ApplicationPort) GetDestinationPort

func (x *ApplicationPort) GetDestinationPort() uint32

func (*ApplicationPort) GetOriginatorPort

func (x *ApplicationPort) GetOriginatorPort() uint32

func (*ApplicationPort) ProtoMessage

func (*ApplicationPort) ProtoMessage()

func (*ApplicationPort) ProtoReflect

func (x *ApplicationPort) ProtoReflect() protoreflect.Message

func (*ApplicationPort) Reset

func (x *ApplicationPort) Reset()

func (*ApplicationPort) String

func (x *ApplicationPort) String() string

type MessageClass

type MessageClass int32

* The class of the message.

See https://en.wikipedia.org/wiki/Data_Coding_Scheme#Message_Classes

const (
	// No message class specified.
	MessageClass_MESSAGE_CLASS_UNSPECIFIED MessageClass = 0
	// CLASS 0
	// A flash message is a message that is not stored on the device. It is handled
	// immediately or dropped, and also cannot be multi-fragment. Data messages of
	// this type needs a destination application port to designate what app will
	// handle it.
	MessageClass_MESSAGE_CLASS_FLASH_MESSAGE MessageClass = 1
	// CLASS 1
	// Mobile Equipment specific messages are handled by by an application on the
	// handset device itself, e.g. WAP push messages. Data messages of this type
	// needs a destination application port to designate what app will handle it.
	MessageClass_MESSAGE_CLASS_ME_SPECIFIC MessageClass = 2
	// CLASS 2
	// Handled by the sim card. SIM updates have special requirements tied to the
	// SIM card itself, and must be signed with a SIM specific private key only known
	// by the operator.
	MessageClass_MESSAGE_CLASS_SIM_SPECIFIC MessageClass = 3
	// CLASS 3
	// Terminal Equipment specific message are handled by the handset itself, or by
	// a SIM application, and may require an application port to designate who will
	// handle it.
	MessageClass_MESSAGE_CLASS_TE_SPECIFIC MessageClass = 4
)

func (MessageClass) Descriptor

func (MessageClass) Enum

func (x MessageClass) Enum() *MessageClass

func (MessageClass) EnumDescriptor deprecated

func (MessageClass) EnumDescriptor() ([]byte, []int)

Deprecated: Use MessageClass.Descriptor instead.

func (MessageClass) Number

func (MessageClass) String

func (x MessageClass) String() string

func (MessageClass) Type

type SendDataToSubscriberRequest

type SendDataToSubscriberRequest struct {

	// The binary content of the data SMS. Must be at least 1 byte, and maximum
	// 2000 bytes.
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// The destination phone number of the subscriber to receive the
	// message. Must be international number starting with '+'.
	ToSubscriber string `protobuf:"bytes,2,opt,name=to_subscriber,json=toSubscriber,proto3" json:"to_subscriber,omitempty"`
	// Origin address of the message.
	//
	// It can either be a
	// - a phone number formatted as E.164 starting with '+'.
	// - a alphanumeric sender ID.
	// - short form number.
	// - network specific number.
	//
	// Typical values here would be to send from your product's name.
	//
	// Important: Address must be pre-approved by Working Group Two.
	// See docs on origin addresses for what is allowed.
	FromAddress string `protobuf:"bytes,3,opt,name=from_address,json=fromAddress,proto3" json:"from_address,omitempty"`
	// Deadline to which the message needs to be delivered. If this is passed
	// and a delivery is not succeeded, the message delivery will fail. If not set
	// will use the maximum deadline. Maximum is 7 days.
	DeliveryDeadline *durationpb.Duration `protobuf:"bytes,4,opt,name=delivery_deadline,json=deliveryDeadline,proto3" json:"delivery_deadline,omitempty"`
	// The message class to use for the data SMS message.
	MessageClass MessageClass `` /* 129-byte string literal not displayed */
	// The application port for the message.
	ApplicationPort *ApplicationPort `protobuf:"bytes,6,opt,name=application_port,json=applicationPort,proto3" json:"application_port,omitempty"`
	// contains filtered or unexported fields
}

func (*SendDataToSubscriberRequest) Descriptor deprecated

func (*SendDataToSubscriberRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendDataToSubscriberRequest.ProtoReflect.Descriptor instead.

func (*SendDataToSubscriberRequest) GetApplicationPort

func (x *SendDataToSubscriberRequest) GetApplicationPort() *ApplicationPort

func (*SendDataToSubscriberRequest) GetContent

func (x *SendDataToSubscriberRequest) GetContent() []byte

func (*SendDataToSubscriberRequest) GetDeliveryDeadline

func (x *SendDataToSubscriberRequest) GetDeliveryDeadline() *durationpb.Duration

func (*SendDataToSubscriberRequest) GetFromAddress

func (x *SendDataToSubscriberRequest) GetFromAddress() string

func (*SendDataToSubscriberRequest) GetMessageClass

func (x *SendDataToSubscriberRequest) GetMessageClass() MessageClass

func (*SendDataToSubscriberRequest) GetToSubscriber

func (x *SendDataToSubscriberRequest) GetToSubscriber() string

func (*SendDataToSubscriberRequest) ProtoMessage

func (*SendDataToSubscriberRequest) ProtoMessage()

func (*SendDataToSubscriberRequest) ProtoReflect

func (*SendDataToSubscriberRequest) Reset

func (x *SendDataToSubscriberRequest) Reset()

func (*SendDataToSubscriberRequest) String

func (x *SendDataToSubscriberRequest) String() string

type SendMessageResponse

type SendMessageResponse struct {

	// An ID representing the message. For events etc related to the message, this ID
	// will be used in the event as identifier.
	MessageId string `protobuf:"bytes,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// The response status for attempting to send the message.
	Status SendMessageResponse_SendStatus `protobuf:"varint,2,opt,name=status,proto3,enum=wgtwo.sms.v1.SendMessageResponse_SendStatus" json:"status,omitempty"`
	// Human readable description for what failed or rejected the message.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Number of fragments sent. This is because of the underlying SMS protocols only
	// supports sending 140 bytes per message after encoding and packing. This is including
	// extra encoding info and correlation and part handling for multi-fragmented messages.
	NumFragments uint32 `protobuf:"varint,4,opt,name=num_fragments,json=numFragments,proto3" json:"num_fragments,omitempty"`
	// contains filtered or unexported fields
}

func (*SendMessageResponse) Descriptor deprecated

func (*SendMessageResponse) Descriptor() ([]byte, []int)

Deprecated: Use SendMessageResponse.ProtoReflect.Descriptor instead.

func (*SendMessageResponse) GetDescription

func (x *SendMessageResponse) GetDescription() string

func (*SendMessageResponse) GetMessageId

func (x *SendMessageResponse) GetMessageId() string

func (*SendMessageResponse) GetNumFragments

func (x *SendMessageResponse) GetNumFragments() uint32

func (*SendMessageResponse) GetStatus

func (*SendMessageResponse) ProtoMessage

func (*SendMessageResponse) ProtoMessage()

func (*SendMessageResponse) ProtoReflect

func (x *SendMessageResponse) ProtoReflect() protoreflect.Message

func (*SendMessageResponse) Reset

func (x *SendMessageResponse) Reset()

func (*SendMessageResponse) String

func (x *SendMessageResponse) String() string

type SendMessageResponse_SendStatus

type SendMessageResponse_SendStatus int32
const (
	SendMessageResponse_SEND_STATUS_UNSPECIFIED SendMessageResponse_SendStatus = 0
	// Sending the message is accepted. Note that the message is not delivered yet.
	SendMessageResponse_SEND_STATUS_OK SendMessageResponse_SendStatus = 1
	// Sending the message is rejected (not allowed). This may be because of
	// subscriber policy limitations, rights of the product or content of the
	// message. See description for details.
	SendMessageResponse_SEND_STATUS_REJECT SendMessageResponse_SendStatus = 2
	// Sending the message failed. This error should be treated as temporary, and
	// sending the message again may work.
	SendMessageResponse_SEND_STATUS_ERROR SendMessageResponse_SendStatus = 3
)

func (SendMessageResponse_SendStatus) Descriptor

func (SendMessageResponse_SendStatus) Enum

func (SendMessageResponse_SendStatus) EnumDescriptor deprecated

func (SendMessageResponse_SendStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use SendMessageResponse_SendStatus.Descriptor instead.

func (SendMessageResponse_SendStatus) Number

func (SendMessageResponse_SendStatus) String

func (SendMessageResponse_SendStatus) Type

type SendTextFromSubscriberRequest

type SendTextFromSubscriberRequest struct {

	// The message text content. Minimum 1 character, maximum 2000 characters. Supports
	// unicode, though completeness is dependent on the receiver handset.
	Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// The subscriber number to send this. The sending product must have a right
	// to send as the subscriber specifically. E.g. operators can only send as
	// their own subscribers, third party products only as subscribers who have
	// enabled the product. Must be international number starting with '+'.
	FromSubscriber string `protobuf:"bytes,2,opt,name=from_subscriber,json=fromSubscriber,proto3" json:"from_subscriber,omitempty"`
	// The destination number of the message. Can be international starting
	// with '+', short form number or network specific numbers.
	ToAddress string `protobuf:"bytes,3,opt,name=to_address,json=toAddress,proto3" json:"to_address,omitempty"`
	// Deadline to which the message needs to be delivered. If this is passed
	// and a delivery is not succeeded, the message delivery will fail. If not set
	// will use the maximum deadline. Maximum is 7 days.
	DeliveryDeadline *durationpb.Duration `protobuf:"bytes,4,opt,name=delivery_deadline,json=deliveryDeadline,proto3" json:"delivery_deadline,omitempty"`
	// contains filtered or unexported fields
}

func (*SendTextFromSubscriberRequest) Descriptor deprecated

func (*SendTextFromSubscriberRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendTextFromSubscriberRequest.ProtoReflect.Descriptor instead.

func (*SendTextFromSubscriberRequest) GetContent

func (x *SendTextFromSubscriberRequest) GetContent() string

func (*SendTextFromSubscriberRequest) GetDeliveryDeadline

func (x *SendTextFromSubscriberRequest) GetDeliveryDeadline() *durationpb.Duration

func (*SendTextFromSubscriberRequest) GetFromSubscriber

func (x *SendTextFromSubscriberRequest) GetFromSubscriber() string

func (*SendTextFromSubscriberRequest) GetToAddress

func (x *SendTextFromSubscriberRequest) GetToAddress() string

func (*SendTextFromSubscriberRequest) ProtoMessage

func (*SendTextFromSubscriberRequest) ProtoMessage()

func (*SendTextFromSubscriberRequest) ProtoReflect

func (*SendTextFromSubscriberRequest) Reset

func (x *SendTextFromSubscriberRequest) Reset()

func (*SendTextFromSubscriberRequest) String

type SendTextToSubscriberRequest

type SendTextToSubscriberRequest struct {

	// The message text content. Minimum 1 character, maximum 2000 characters. Supports
	// unicode, though completeness is dependent on the receiver handset.
	Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// The destination phone number of the subscriber to receive the
	// message. Must be international number starting with '+'.
	ToSubscriber string `protobuf:"bytes,2,opt,name=to_subscriber,json=toSubscriber,proto3" json:"to_subscriber,omitempty"`
	// Origin address of the message.
	//
	// It can either be a
	// - a phone number formatted as E.164 starting with '+'.
	// - a alphanumeric sender ID.
	// - short form number.
	// - network specific number.
	//
	// Typical values here would be to send from your product's name.
	//
	// Important: Address must be pre-approved by Working Group Two.
	// See docs on origin addresses for what is allowed.
	FromAddress string `protobuf:"bytes,3,opt,name=from_address,json=fromAddress,proto3" json:"from_address,omitempty"`
	// Deadline to which the message needs to be delivered. If this is passed
	// and a delivery is not succeeded, the message delivery will fail. If not set
	// will use the maximum deadline. Maximum is 7 days.
	DeliveryDeadline *durationpb.Duration `protobuf:"bytes,4,opt,name=delivery_deadline,json=deliveryDeadline,proto3" json:"delivery_deadline,omitempty"`
	// contains filtered or unexported fields
}

func (*SendTextToSubscriberRequest) Descriptor deprecated

func (*SendTextToSubscriberRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendTextToSubscriberRequest.ProtoReflect.Descriptor instead.

func (*SendTextToSubscriberRequest) GetContent

func (x *SendTextToSubscriberRequest) GetContent() string

func (*SendTextToSubscriberRequest) GetDeliveryDeadline

func (x *SendTextToSubscriberRequest) GetDeliveryDeadline() *durationpb.Duration

func (*SendTextToSubscriberRequest) GetFromAddress

func (x *SendTextToSubscriberRequest) GetFromAddress() string

func (*SendTextToSubscriberRequest) GetToSubscriber

func (x *SendTextToSubscriberRequest) GetToSubscriber() string

func (*SendTextToSubscriberRequest) ProtoMessage

func (*SendTextToSubscriberRequest) ProtoMessage()

func (*SendTextToSubscriberRequest) ProtoReflect

func (*SendTextToSubscriberRequest) Reset

func (x *SendTextToSubscriberRequest) Reset()

func (*SendTextToSubscriberRequest) String

func (x *SendTextToSubscriberRequest) String() string

type SmsServiceClient

type SmsServiceClient interface {
	// Send a text SMS message from the subscriber to any number the subscriber
	// can send to.
	SendTextFromSubscriber(ctx context.Context, in *SendTextFromSubscriberRequest, opts ...grpc.CallOption) (*SendMessageResponse, error)
	// Send a text SMS message to the subscriber as any sender address the
	// product has a right to send as.
	SendTextToSubscriber(ctx context.Context, in *SendTextToSubscriberRequest, opts ...grpc.CallOption) (*SendMessageResponse, error)
	// Send a data SMS message to the subscriber as any sender address the
	// product has a right to send as.
	SendDataToSubscriber(ctx context.Context, in *SendDataToSubscriberRequest, opts ...grpc.CallOption) (*SendMessageResponse, error)
}

SmsServiceClient is the client API for SmsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewSmsServiceClient

func NewSmsServiceClient(cc grpc.ClientConnInterface) SmsServiceClient

type SmsServiceServer

type SmsServiceServer interface {
	// Send a text SMS message from the subscriber to any number the subscriber
	// can send to.
	SendTextFromSubscriber(context.Context, *SendTextFromSubscriberRequest) (*SendMessageResponse, error)
	// Send a text SMS message to the subscriber as any sender address the
	// product has a right to send as.
	SendTextToSubscriber(context.Context, *SendTextToSubscriberRequest) (*SendMessageResponse, error)
	// Send a data SMS message to the subscriber as any sender address the
	// product has a right to send as.
	SendDataToSubscriber(context.Context, *SendDataToSubscriberRequest) (*SendMessageResponse, error)
}

SmsServiceServer is the server API for SmsService service. All implementations should embed UnimplementedSmsServiceServer for forward compatibility

type UnimplementedSmsServiceServer

type UnimplementedSmsServiceServer struct {
}

UnimplementedSmsServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedSmsServiceServer) SendDataToSubscriber

func (UnimplementedSmsServiceServer) SendTextFromSubscriber

func (UnimplementedSmsServiceServer) SendTextToSubscriber

type UnsafeSmsServiceServer

type UnsafeSmsServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSmsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SmsServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL