001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.messages.sms;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.JsonableBaseObject;
020
021/**
022 * Used to describe inbound SMS metadata.
023 *
024 * @since 7.2.0
025 */
026public final class SmsInboundMetadata extends JsonableBaseObject {
027        private Integer numMessages, totalCount;
028        private String keyword;
029
030        SmsInboundMetadata() {}
031
032        /**
033         * The number of inbound SMS messages concatenated together to comprise this message. SMS messages are 160
034         * characters, if an inbound message exceeds that size they are concatenated together to form a single message.
035         * This number indicates how many messages formed this webhook.
036         *
037         * @return The total number of SMS messages used to create the text message.
038         */
039        @JsonProperty("num_messages")
040        public Integer getNumMessages() {
041                return numMessages;
042        }
043
044        /**
045         * The number of inbound SMS messages concatenated together to comprise this message. SMS messages are 160
046         * characters, if an inbound message exceeds that size they are concatenated together to form a single message.
047         * This number indicates how many messages formed this webhook.
048         *
049         * @return The total number of SMS messages used to create the text message.
050         */
051        @JsonProperty("total_count")
052        public Integer getTotalCount() {
053                return totalCount;
054        }
055
056        /**
057         * The first word of the message sent to uppercase.
058         *
059         * @return The keyword.
060         */
061        @JsonProperty("keyword")
062        public String getKeyword() {
063                return keyword;
064        }
065}