ऐप सर्वर बनाएं अनुरोध भेजें

फायरबेस एडमिन एसडीके या एफसीएम ऐप सर्वर प्रोटोकॉल का उपयोग करके, आप संदेश अनुरोध बना सकते हैं और उन्हें इस प्रकार के लक्ष्यों पर भेज सकते हैं:

  • विषय का नाम
  • स्थिति
  • डिवाइस पंजीकरण टोकन
  • डिवाइस समूह का नाम (केवल प्रोटोकॉल)

आप पूर्वनिर्धारित फ़ील्ड से बने अधिसूचना पेलोड, अपने स्वयं के उपयोगकर्ता-परिभाषित फ़ील्ड के डेटा पेलोड या दोनों प्रकार के पेलोड वाले संदेश के साथ संदेश भेज सकते हैं। अधिक जानकारी के लिए संदेश प्रकार देखें.

इस पृष्ठ के उदाहरण दिखाते हैं कि फायरबेस एडमिन एसडीके (जिसमें नोड , जावा , पायथन , सी# और गो के लिए समर्थन है) और वी1 HTTP प्रोटोकॉल का उपयोग करके अधिसूचना संदेश कैसे भेजा जाए। अप्रचलित विरासत HTTP और XMPP प्रोटोकॉल के माध्यम से संदेश भेजने के लिए भी मार्गदर्शन है।

विशिष्ट उपकरणों पर संदेश भेजें

किसी एकल, विशिष्ट डिवाइस पर भेजने के लिए, दिखाए गए अनुसार डिवाइस का पंजीकरण टोकन पास करें। पंजीकरण टोकन के बारे में अधिक जानने के लिए अपने प्लेटफ़ॉर्म के लिए क्लाइंट सेटअप जानकारी देखें।

नोड.जे.एस

// This registration token comes from the client FCM SDKs.
const registrationToken = 'YOUR_REGISTRATION_TOKEN';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

जावा

// This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

अजगर

# This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

जाना

// Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)

सी#

// This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

कर्ल कमांड:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

सफल होने पर, प्रत्येक भेजने की विधि एक संदेश आईडी लौटाती है। फायरबेस एडमिन एसडीके आईडी स्ट्रिंग को projects/{project_id}/messages/{message_id} प्रारूप में लौटाता है। HTTP प्रोटोकॉल प्रतिक्रिया एक एकल JSON कुंजी है:

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

एकाधिक डिवाइस पर संदेश भेजें

एडमिन एफसीएम एपीआई आपको डिवाइस पंजीकरण टोकन की सूची में एक संदेश को मल्टीकास्ट करने की अनुमति देता है। आप प्रति आमंत्रण 500 डिवाइस पंजीकरण टोकन तक निर्दिष्ट कर सकते हैं।

नोड.जे.एस

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

जावा

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");

अजगर

# Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))

जाना

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)

सी#

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");

रिटर्न वैल्यू टोकन की एक सूची है जो इनपुट टोकन के क्रम से मेल खाती है। यह तब उपयोगी होता है जब आप यह जांचना चाहते हैं कि किन टोकन के परिणामस्वरूप त्रुटियां हुईं।

नोड.जे.एस

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });

जावा

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
}

अजगर

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens))

जाना

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
}

सी#

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}

विषयों पर संदेश भेजें

आपके द्वारा एक विषय बनाने के बाद, या तो क्लाइंट साइड पर विषय के लिए क्लाइंट ऐप इंस्टेंस की सदस्यता लेकर या सर्वर एपीआई के माध्यम से, आप विषय पर संदेश भेज सकते हैं। यदि आप पहली बार एफसीएम के लिए अनुरोध भेज रहे हैं, तो महत्वपूर्ण पृष्ठभूमि और सेटअप जानकारी के लिए अपने सर्वर वातावरण और एफसीएम के लिए मार्गदर्शिका देखें।

बैकएंड पर अपने भेजने वाले तर्क में, वांछित विषय का नाम निर्दिष्ट करें जैसा कि दिखाया गया है:

नोड.जे.एस

// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

जावा

// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setTopic(topic)
    .build();

// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

अजगर

# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    topic=topic,
)

# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

जाना

// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Topic: topic,
}

// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)

सी#

// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Topic = topic,
};

// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
    "topic" : "foo-bar",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message"
      }
   }
}

कर्ल कमांड:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "message": {
    "topic" : "foo-bar",
    "notification": {
      "body": "This is a Firebase Cloud Messaging Topic Message!",
      "title": "FCM Message"
    }
  }
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

विषयों के संयोजन के लिए एक संदेश भेजने के लिए, एक शर्त निर्दिष्ट करें, जो एक बूलियन अभिव्यक्ति है जो लक्ष्य विषयों को निर्दिष्ट करती है। उदाहरण के लिए, निम्न स्थिति उन डिवाइसों को संदेश भेजेगी जो TopicA और TopicB या TopicC की सदस्यता लेते हैं:

"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"

एफसीएम पहले कोष्ठक में किसी भी स्थिति का मूल्यांकन करता है, और फिर बाएं से दाएं अभिव्यक्ति का मूल्यांकन करता है। उपरोक्त अभिव्यक्ति में, किसी एक विषय की सदस्यता लेने वाले उपयोगकर्ता को संदेश प्राप्त नहीं होता है। इसी तरह, जो उपयोगकर्ता TopicA की सदस्यता नहीं लेता है उसे संदेश प्राप्त नहीं होता है। ये संयोजन इसे प्राप्त करते हैं:

  • TopicA और TopicB
  • TopicA और TopicC

आप अपनी सशर्त अभिव्यक्ति में अधिकतम पाँच विषय शामिल कर सकते हैं।

किसी शर्त पर भेजने के लिए:

नोड.जे.एस

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';

// See documentation on defining a message payload.
const message = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  condition: condition
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

जावा

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setCondition(condition)
    .build();

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

अजगर

# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"

# See documentation on defining a message payload.
message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    condition=condition,
)

# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

जाना

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Condition: condition,
}

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)

सी#

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = new Message()
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Condition = condition,
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
   "message":{
    "condition": "'dogs' in topics || 'cats' in topics",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message",
    }
  }
}

कर्ल कमांड:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "notification": {
    "title": "FCM Message",
    "body": "This is a Firebase Cloud Messaging Topic Message!",
  },
  "condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

डिवाइस समूहों को संदेश भेजें

डिवाइस समूहों को संदेश भेजने के लिए, HTTP v1 API का उपयोग करें। यदि आप वर्तमान में HTTP या XMPP के लिए अप्रचलित लीगेसी सेंड API, या लीगेसी प्रोटोकॉल के आधार पर Node.js के लिए फायरबेस एडमिन SDK के किसी पुराने संस्करण का उपयोग करके डिवाइस समूहों को भेज रहे हैं, तो हम दृढ़ता से अनुशंसा करते हैं कि आप HTTP v1 पर माइग्रेट करें जल्द से जल्द अवसर पर एपीआई । जून 2024 में लीगेसी सेंड एपीआई अक्षम कर दी जाएगी और हटा दी जाएगी।

किसी डिवाइस समूह में संदेश भेजना किसी व्यक्तिगत डिवाइस पर संदेश भेजने के समान है, अनुरोध भेजने को अधिकृत करने के लिए उसी विधि का उपयोग किया जाता है। token फ़ील्ड को समूह अधिसूचना कुंजी पर सेट करें:

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ",
      "data":{
        "hello": "This is a Firebase Cloud Messaging device group message!"
      }
   }
}

कर्ल कमांड

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "data":{
     "hello": "This is a Firebase Cloud Messaging device group message!"
   },
   "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

संदेशों का एक बैच भेजें

एडमिन एसडीके बैचों में संदेश भेजने का समर्थन करते हैं। आप 500 संदेशों को एक बैच में समूहित कर सकते हैं और उन सभी को एक ही एपीआई कॉल में भेज सकते हैं, प्रत्येक संदेश के लिए अलग-अलग HTTP अनुरोध भेजने पर महत्वपूर्ण प्रदर्शन सुधार के साथ।

इस सुविधा का उपयोग संदेशों का एक अनुकूलित सेट बनाने और उन्हें विषयों या विशिष्ट डिवाइस पंजीकरण टोकन सहित विभिन्न प्राप्तकर्ताओं को भेजने के लिए किया जा सकता है। इस सुविधा का उपयोग तब करें, जब उदाहरण के लिए, आपको संदेश के मुख्य भाग में थोड़े अलग विवरण के साथ अलग-अलग दर्शकों को एक साथ संदेश भेजने की आवश्यकता हो।

नोड.जे.एस

// Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: { title: 'Price drop', body: '5% off all electronics' },
  token: registrationToken,
});
messages.push({
  notification: { title: 'Price drop', body: '2% off all books' },
  topic: 'readers-club',
});

getMessaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

जावा

// Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("5% off all electronics")
            .build())
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("2% off all books")
            .build())
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");

अजगर

# Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))

जाना

// Create a list containing up to 500 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)

सी#

// Create a list containing up to 500 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");

सीधे बूट-सक्षम संदेश भेजें (केवल Android)

आप HTTP v1 या लीगेसी HTTP API का उपयोग करके सीधे बूट मोड में डिवाइस पर संदेश भेज सकते हैं। डायरेक्ट बूट मोड में डिवाइसों को भेजने से पहले, सुनिश्चित करें कि आपने क्लाइंट डिवाइसों को डायरेक्ट बूट मोड में एफसीएम संदेश प्राप्त करने में सक्षम करने के चरण पूरे कर लिए हैं।

FCM v1 HTTP API का उपयोग करके भेजें

संदेश अनुरोध में कुंजी "direct_boot_ok" शामिल होनी चाहिए: अनुरोध निकाय के AndroidConfig विकल्पों में "direct_boot_ok" : true । उदाहरण के लिए:

https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}

FCM लीगेसी HTTP API का उपयोग करके भेजें

संदेश अनुरोध में अनुरोध निकाय के शीर्ष स्तर पर कुंजी "direct_boot_ok" : true शामिल होनी चाहिए। उदाहरण के लिए:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  "direct_boot_ok" : true
}

अनुरोध निकाय में इस कुंजी के साथ भेजे गए संदेशों को वर्तमान में डायरेक्ट बूट मोड में (और उस मोड में नहीं होने पर भी) डिवाइस पर ऐप्स द्वारा नियंत्रित किया जा सकता है।

सभी प्लेटफ़ॉर्म पर संदेशों को अनुकूलित करें

फायरबेस एडमिन एसडीके और एफसीएम v1 HTTP प्रोटोकॉल दोनों आपके संदेश अनुरोधों को message ऑब्जेक्ट में उपलब्ध सभी फ़ील्ड सेट करने की अनुमति देते हैं। यह भी शामिल है:

  • संदेश प्राप्त करने वाले सभी ऐप इंस्टेंस द्वारा व्याख्या किए जाने वाले फ़ील्ड का एक सामान्य सेट।
  • फ़ील्ड के प्लेटफ़ॉर्म-विशिष्ट सेट, जैसे कि AndroidConfig और WebpushConfig , केवल निर्दिष्ट प्लेटफ़ॉर्म पर चल रहे ऐप इंस्टेंस द्वारा व्याख्या किए जाते हैं।

प्लेटफ़ॉर्म-विशिष्ट ब्लॉक आपको विभिन्न प्लेटफ़ॉर्म के लिए संदेशों को अनुकूलित करने की सुविधा देते हैं ताकि यह सुनिश्चित हो सके कि प्राप्त होने पर उन्हें सही ढंग से संभाला जाए। एफसीएम बैकएंड सभी निर्दिष्ट मापदंडों को ध्यान में रखेगा और प्रत्येक प्लेटफ़ॉर्म के लिए संदेश को अनुकूलित करेगा।

सामान्य फ़ील्ड का उपयोग कब करें

जब आप हों तो सामान्य फ़ील्ड का उपयोग करें:

  • सभी प्लेटफ़ॉर्म - Apple, Android और वेब पर ऐप इंस्टेंस को लक्षित करना
  • विषयों पर संदेश भेजना

सभी ऐप इंस्टेंसेस, प्लेटफ़ॉर्म की परवाह किए बिना, निम्नलिखित सामान्य फ़ील्ड की व्याख्या कर सकते हैं:

प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग कब करें

जब आप चाहें तो प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करें:

  • फ़ील्ड्स को केवल विशेष प्लेटफ़ॉर्म पर भेजें
  • सामान्य फ़ील्ड के अतिरिक्त प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड भेजें

जब भी आप केवल विशेष प्लेटफ़ॉर्म पर मान भेजना चाहते हैं, तो सामान्य फ़ील्ड का उपयोग न करें ; प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करें. उदाहरण के लिए, केवल Apple प्लेटफ़ॉर्म और वेब पर अधिसूचना भेजने के लिए, लेकिन Android पर नहीं, आपको फ़ील्ड के दो अलग-अलग सेटों का उपयोग करना होगा, एक Apple के लिए और एक वेब के लिए।

जब आप विशिष्ट डिलीवरी विकल्पों के साथ संदेश भेज रहे हैं, तो उन्हें सेट करने के लिए प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करें। यदि आप चाहें तो आप प्रति प्लेटफ़ॉर्म अलग-अलग मान निर्दिष्ट कर सकते हैं। हालाँकि, जब आप अनिवार्य रूप से सभी प्लेटफ़ॉर्म पर समान मान सेट करना चाहते हैं, तब भी आपको प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करना होगा। ऐसा इसलिए है क्योंकि प्रत्येक प्लेटफ़ॉर्म मूल्य की थोड़ी अलग व्याख्या कर सकता है - उदाहरण के लिए, एंड्रॉइड पर टाइम-टू-लाइव को सेकंड में समाप्ति समय के रूप में सेट किया जाता है, जबकि ऐप्पल पर इसे समाप्ति तिथि के रूप में सेट किया जाता है।

उदाहरण: रंग और आइकन विकल्पों के साथ अधिसूचना संदेश

यह उदाहरण भेजें अनुरोध सभी प्लेटफ़ॉर्म पर एक सामान्य अधिसूचना शीर्षक और सामग्री भेजता है, लेकिन यह एंड्रॉइड डिवाइसों पर कुछ प्लेटफ़ॉर्म-विशिष्ट ओवरराइड भी भेजता है।

एंड्रॉइड के लिए, अनुरोध एंड्रॉइड डिवाइस पर प्रदर्शित करने के लिए एक विशेष आइकन और रंग सेट करता है। जैसा कि AndroidNotification के संदर्भ में बताया गया है, रंग #rrggbb प्रारूप में निर्दिष्ट है, और छवि एंड्रॉइड ऐप के लिए स्थानीय रूप से खींचने योग्य आइकन संसाधन होनी चाहिए।

यहां उपयोगकर्ता के डिवाइस पर दृश्य प्रभाव का एक अनुमान दिया गया है:

दो डिवाइसों का सरल चित्रण, जिसमें एक कस्टम आइकन और रंग प्रदर्शित करता है

नोड.जे.एस

const topicName = 'industry-tech';

const message = {
  notification: {
    title: '`$FooCorp` up 1.43% on the day',
    body: 'FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  android: {
    notification: {
      icon: 'stock_ticker_update',
      color: '#7e55c3'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

जावा

Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build();

अजगर

message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
)

जाना

oneHour := time.Duration(1) * time.Hour
badge := 42
message := &messaging.Message{
	Notification: &messaging.Notification{
		Title: "$GOOG up 1.43% on the day",
		Body:  "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
}

सी#

var message = new Message
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
};

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"`$FooCorp` up 1.43% on the day",
       "body":"FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day."
     },
     "android":{
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#7e55c3"
       }
     }
   }
 }

संदेश के मुख्य भाग में प्लेटफ़ॉर्म-विशिष्ट ब्लॉकों में उपलब्ध कुंजियों पर संपूर्ण विवरण के लिए HTTP v1 संदर्भ दस्तावेज़ देखें।

उदाहरण: एक कस्टम छवि के साथ अधिसूचना संदेश

निम्नलिखित उदाहरण भेजें अनुरोध सभी प्लेटफ़ॉर्म पर एक सामान्य अधिसूचना शीर्षक भेजता है, लेकिन यह एक छवि भी भेजता है। यहां उपयोगकर्ता के डिवाइस पर दृश्य प्रभाव का एक अनुमान दिया गया है:

एक प्रदर्शन अधिसूचना में एक छवि का सरल चित्रण

नोड.जे.एस

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Sparky says hello!'
  },
  android: {
    notification: {
      imageUrl: 'https://foo.bar.pizza-monster.png'
    }
  },
  apns: {
    payload: {
      aps: {
        'mutable-content': 1
      }
    },
    fcm_options: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  webpush: {
    headers: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Sparky says hello!",
     },
     "android":{
       "notification":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "mutable-content":1
         }
       },
       "fcm_options": {
           "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "webpush":{
       "headers":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     }
   }
 }

संदेश के मुख्य भाग में प्लेटफ़ॉर्म-विशिष्ट ब्लॉकों में उपलब्ध कुंजियों पर संपूर्ण विवरण के लिए HTTP v1 संदर्भ दस्तावेज़ देखें।

उदाहरण: संबंधित क्लिक क्रिया के साथ अधिसूचना संदेश

निम्नलिखित उदाहरण भेजें अनुरोध सभी प्लेटफार्मों पर एक सामान्य अधिसूचना शीर्षक भेजता है, लेकिन यह अधिसूचना के साथ उपयोगकर्ता के इंटरैक्ट करने के जवाब में ऐप को प्रदर्शन करने के लिए एक कार्रवाई भी भेजता है। यहां उपयोगकर्ता के डिवाइस पर दृश्य प्रभाव का एक अनुमान दिया गया है:

एक वेब पेज खोलने वाले उपयोगकर्ता टैप का सरल चित्रण

नोड.जे.एस

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Breaking News....'
  },
  android: {
    notification: {
      clickAction: 'news_intent'
    }
  },
  apns: {
    payload: {
      aps: {
        'category': 'INVITE_CATEGORY'
      }
    }
  },
  webpush: {
    fcmOptions: {
      link: 'breakingnews.html'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Breaking News...",
     },
     "android":{
       "notification":{
         "click_action":"news_intent"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "category" : "INVITE_CATEGORY"
         }
       },
     },
     "webpush":{
       "fcm_options":{
         "link":"breakingnews.html"
       }
     }
   }
 }

संदेश के मुख्य भाग में प्लेटफ़ॉर्म-विशिष्ट ब्लॉकों में उपलब्ध कुंजियों पर संपूर्ण विवरण के लिए HTTP v1 संदर्भ दस्तावेज़ देखें।

उदाहरण: स्थानीयकरण विकल्पों के साथ अधिसूचना संदेश

निम्नलिखित उदाहरण भेजें अनुरोध क्लाइंट को स्थानीयकृत संदेश प्रदर्शित करने के लिए स्थानीयकरण विकल्प भेजता है। यहां उपयोगकर्ता के डिवाइस पर दृश्य प्रभाव का एक अनुमान दिया गया है:

अंग्रेजी और स्पैनिश में पाठ प्रदर्शित करने वाले दो उपकरणों का सरल चित्रण

नोड.जे.एस

var topicName = 'industry-tech';

var message = {
  android: {
    ttl: 3600000,
    notification: {
      bodyLocKey: 'STOCK_NOTIFICATION_BODY',
      bodyLocArgs: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        alert: {
          locKey: 'STOCK_NOTIFICATION_BODY',
          locArgs: ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

आराम

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
             "topic":"Tech",
             "android":{
               "ttl":"3600s",
               "notification":{
                 "body_loc_key": "STOCK_NOTIFICATION_BODY",
                 "body_loc_args":  ["FooCorp", "11.80", "835.67", "1.43"],
               },
             },
             "apns":{
               "payload":{
                 "aps":{
                   "alert" : {
                     "loc-key": "STOCK_NOTIFICATION_BODY",
                     "loc-args":  ["FooCorp", "11.80", "835.67", "1.43"],
                    },
                 },
               },
             },
  },
}'

संदेश के मुख्य भाग में प्लेटफ़ॉर्म-विशिष्ट ब्लॉकों में उपलब्ध कुंजियों पर संपूर्ण विवरण के लिए HTTP v1 संदर्भ दस्तावेज़ देखें।

व्यवस्थापक त्रुटि कोड

निम्न तालिका अनुशंसित समाधान चरणों सहित फायरबेस एडमिन एफसीएम एपीआई त्रुटि कोड और उनके विवरण सूचीबद्ध करती है।

त्रुटि कोड विवरण और समाधान चरण
messaging/invalid-argument एफसीएम पद्धति के लिए एक अमान्य तर्क प्रदान किया गया था। त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए.
messaging/invalid-recipient इच्छित संदेश प्राप्तकर्ता अमान्य है. त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए.
messaging/invalid-payload एक अमान्य संदेश पेलोड ऑब्जेक्ट प्रदान किया गया था। त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए.
messaging/invalid-data-payload-key डेटा संदेश पेलोड में एक अमान्य कुंजी है। प्रतिबंधित कुंजियों के लिए DataMessagePayload का संदर्भ दस्तावेज़ देखें।
messaging/payload-size-limit-exceeded प्रदत्त संदेश पेलोड एफसीएम आकार सीमा से अधिक है। अधिकांश संदेशों के लिए सीमा 4096 बाइट्स है। विषयों पर भेजे गए संदेशों के लिए सीमा 2048 बाइट्स है। कुल पेलोड आकार में कुंजी और मान दोनों शामिल हैं।
messaging/invalid-options एक अमान्य संदेश विकल्प ऑब्जेक्ट प्रदान किया गया था. त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए.
messaging/invalid-registration-token अमान्य पंजीकरण टोकन प्रदान किया गया. सुनिश्चित करें कि यह एफसीएम के साथ पंजीकरण करने पर क्लाइंट ऐप को प्राप्त पंजीकरण टोकन से मेल खाता है। इसमें अतिरिक्त अक्षर न काटें या न जोड़ें।
messaging/registration-token-not-registered प्रदान किया गया पंजीकरण टोकन पंजीकृत नहीं है। पहले से मान्य पंजीकरण टोकन को कई कारणों से अपंजीकृत किया जा सकता है, जिनमें शामिल हैं:
  • क्लाइंट ऐप ने स्वयं को FCM से अपंजीकृत कर लिया।
  • क्लाइंट ऐप स्वचालित रूप से अपंजीकृत हो गया था। ऐसा तब हो सकता है जब उपयोगकर्ता एप्लिकेशन को अनइंस्टॉल कर देता है या, Apple प्लेटफ़ॉर्म पर, यदि APNs फीडबैक सेवा APNs टोकन को अमान्य बताती है।
  • पंजीकरण टोकन समाप्त हो गया. उदाहरण के लिए, Google पंजीकरण टोकन को ताज़ा करने का निर्णय ले सकता है या Apple उपकरणों के लिए APNs टोकन समाप्त हो सकता है।
  • क्लाइंट ऐप अपडेट किया गया था, लेकिन नया संस्करण संदेश प्राप्त करने के लिए कॉन्फ़िगर नहीं किया गया है।
इन सभी मामलों के लिए, इस पंजीकरण टोकन को हटा दें और संदेश भेजने के लिए इसका उपयोग बंद कर दें।
messaging/invalid-package-name संदेश एक पंजीकरण टोकन को संबोधित किया गया था जिसका पैकेज नाम प्रदत्त restrictedPackageName विकल्प से मेल नहीं खाता है।
messaging/message-rate-exceeded किसी विशेष लक्ष्य तक संदेशों की दर बहुत अधिक है. इस डिवाइस या विषय पर भेजे गए संदेशों की संख्या कम करें और तुरंत इस लक्ष्य को भेजने का पुनः प्रयास न करें।
messaging/device-message-rate-exceeded किसी विशेष डिवाइस पर संदेशों की दर बहुत अधिक है. इस डिवाइस पर भेजे गए संदेशों की संख्या कम करें और तुरंत इस डिवाइस पर भेजने का पुनः प्रयास न करें।
messaging/topics-message-rate-exceeded किसी विशेष विषय पर ग्राहकों को संदेशों की दर बहुत अधिक है। इस विषय के लिए भेजे गए संदेशों की संख्या कम करें, और तुरंत इस विषय पर भेजने का पुनः प्रयास न करें।
messaging/too-many-topics एक पंजीकरण टोकन को अधिकतम विषयों के लिए सब्सक्राइब किया गया है और किसी भी अधिक के लिए सब्सक्राइब नहीं किया जा सकता है।
messaging/invalid-apns-credentials Apple डिवाइस पर लक्षित संदेश नहीं भेजा जा सका क्योंकि आवश्यक APNs SSL प्रमाणपत्र अपलोड नहीं किया गया था या समाप्त हो गया था। अपने विकास और उत्पादन प्रमाणपत्रों की वैधता की जाँच करें।
messaging/mismatched-credential इस एसडीके को प्रमाणित करने के लिए उपयोग किए गए क्रेडेंशियल को दिए गए पंजीकरण टोकन के अनुरूप डिवाइस पर संदेश भेजने की अनुमति नहीं है। सुनिश्चित करें कि क्रेडेंशियल और पंजीकरण टोकन दोनों एक ही फायरबेस प्रोजेक्ट से संबंधित हैं। फ़ायरबेस एडमिन एसडीके को प्रमाणित करने के तरीके के दस्तावेज़ के लिए अपने ऐप में फ़ायरबेस जोड़ें देखें।
messaging/authentication-error एसडीके एफसीएम सर्वर को प्रमाणित नहीं कर सका। सुनिश्चित करें कि आपने फायरबेस एडमिन एसडीके को एक क्रेडेंशियल के साथ प्रमाणित किया है जिसमें एफसीएम संदेश भेजने की उचित अनुमति है। फ़ायरबेस एडमिन एसडीके को प्रमाणित करने के तरीके के दस्तावेज़ के लिए अपने ऐप में फ़ायरबेस जोड़ें देखें।
messaging/server-unavailable एफसीएम सर्वर समय पर अनुरोध पर कार्रवाई नहीं कर सका। आपको वही अनुरोध पुनः प्रयास करना चाहिए, लेकिन आपको यह करना होगा:
  • यदि एफसीएम कनेक्शन सर्वर से प्रतिक्रिया में शामिल किया गया है तो Retry-After हेडर का सम्मान करें।
  • अपने पुनः प्रयास तंत्र में घातीय बैक-ऑफ लागू करें। उदाहरण के लिए, यदि आपने पहले पुनः प्रयास से पहले एक सेकंड प्रतीक्षा की, तो अगले प्रयास से पहले कम से कम दो सेकंड प्रतीक्षा करें, फिर चार सेकंड, इत्यादि। यदि आप एकाधिक संदेश भेज रहे हैं, तो एक ही समय में सभी संदेशों के लिए नया अनुरोध जारी करने से बचने के लिए प्रत्येक को स्वतंत्र रूप से अतिरिक्त यादृच्छिक राशि से विलंबित करें।
समस्याएँ उत्पन्न करने वाले प्रेषकों को काली सूची में डाले जाने का जोखिम रहता है।
messaging/internal-error अनुरोध को संसाधित करने का प्रयास करते समय FCM सर्वर को एक त्रुटि का सामना करना पड़ा। आप ऊपर messaging/server-unavailable पंक्ति में सूचीबद्ध आवश्यकताओं का पालन करते हुए उसी अनुरोध का पुनः प्रयास कर सकते हैं। यदि त्रुटि बनी रहती है, तो कृपया हमारे बग रिपोर्ट समर्थन चैनल को समस्या की रिपोर्ट करें।
messaging/unknown-error एक अज्ञात सर्वर त्रुटि वापस आ गई। अधिक विवरण के लिए त्रुटि संदेश में अपरिष्कृत सर्वर प्रतिक्रिया देखें। यदि आपको यह त्रुटि प्राप्त होती है, तो कृपया हमारे बग रिपोर्ट समर्थन चैनल को पूर्ण त्रुटि संदेश की रिपोर्ट करें।

लीगेसी ऐप सर्वर प्रोटोकॉल का उपयोग करके संदेश भेजें

यदि आप वर्तमान में लीगेसी प्रोटोकॉल का उपयोग कर रहे हैं, तो इस अनुभाग में दिखाए अनुसार संदेश अनुरोध बनाएं। ध्यान रखें कि, यदि आप HTTP के माध्यम से कई प्लेटफ़ॉर्म पर भेज रहे हैं, तो v1 प्रोटोकॉल आपके संदेश अनुरोधों को बहुत सरल बना सकता है।

विशिष्ट उपकरणों पर संदेश भेजें

विशिष्ट उपकरणों पर संदेश भेजने के लिए, विशिष्ट ऐप इंस्टेंस के लिए पंजीकरण टोकन पर to सेट करें। पंजीकरण टोकन के बारे में अधिक जानने के लिए अपने प्लेटफ़ॉर्म के लिए क्लाइंट सेटअप जानकारी देखें।

HTTP पोस्ट अनुरोध

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

HTTP प्रतिक्रिया

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

एक्सएमपीपी संदेश

<message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>

एक्सएमपीपी प्रतिक्रिया

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

एक्सएमपीपी कनेक्शन सर्वर प्रतिक्रियाओं के लिए कुछ अन्य विकल्प प्रदान करता है। सर्वर प्रतिक्रिया प्रारूप देखें।

क्लाइंट ऐप्स पर डाउनस्ट्रीम संदेश भेजते समय उपलब्ध संदेश विकल्पों की पूरी सूची के लिए, अपने चुने हुए कनेक्शन सर्वर प्रोटोकॉल, HTTP या XMPP के लिए संदर्भ जानकारी देखें।

विषयों पर संदेश भेजें

फायरबेस क्लाउड मैसेजिंग विषय पर संदेश भेजना किसी व्यक्तिगत डिवाइस या उपयोगकर्ता समूह को संदेश भेजने के समान है। ऐप सर्वर /topics/yourTopic जैसे मान के साथ कुंजी to सेट करता है। डेवलपर्स कोई भी विषय नाम चुन सकते हैं जो रेगुलर एक्सप्रेशन से मेल खाता हो: "/topics/[a-zA-Z0-9-_.~%]+"

एकाधिक विषयों के संयोजन को भेजने के लिए, ऐप सर्वर को condition कुंजी ( to के बजाय) को एक बूलियन स्थिति में सेट करना होगा जो लक्ष्य विषयों को निर्दिष्ट करता है। उदाहरण के लिए, उन डिवाइसों पर संदेश भेजने के लिए जिन्होंने TopicA और TopicB या TopicC की सदस्यता ली है:

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

एफसीएम पहले कोष्ठक में किसी भी स्थिति का मूल्यांकन करता है, और फिर बाएं से दाएं अभिव्यक्ति का मूल्यांकन करता है। उपरोक्त अभिव्यक्ति में, किसी एक विषय की सदस्यता लेने वाले उपयोगकर्ता को संदेश प्राप्त नहीं होता है। इसी तरह, जो उपयोगकर्ता TopicA की सदस्यता नहीं लेता है उसे संदेश प्राप्त नहीं होता है। ये संयोजन इसे प्राप्त करते हैं:

  • टॉपिकए और टॉपिकबी
  • टॉपिकए और टॉपिकसी

आप अपनी सशर्त अभिव्यक्ति में अधिकतम पाँच विषय शामिल कर सकते हैं, और कोष्ठक समर्थित हैं। समर्थित ऑपरेटर: && , || .

विषय HTTP पोस्ट अनुरोध

किसी एक विषय पर भेजें:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


"कुत्तों" या "बिल्लियों" विषयों की सदस्यता वाले उपकरणों को भेजें:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


विषय HTTP प्रतिक्रिया

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

विषय एक्सएमपीपी संदेश

किसी एक विषय पर भेजें:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

"कुत्तों" या "बिल्लियों" विषयों की सदस्यता वाले उपकरणों को भेजें:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

विषय एक्सएमपीपी प्रतिक्रिया

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

एफसीएम सर्वर द्वारा विषय भेजे गए अनुरोधों पर सफलता या विफलता प्रतिक्रिया देने से पहले 30 सेकंड तक की देरी की अपेक्षा करें। अनुरोध में ऐप सर्वर का टाइमआउट मान तदनुसार सेट करना सुनिश्चित करें।

डिवाइस समूहों को संदेश भेजें

अप्रचलित लीगेसी एपीआई का उपयोग करके किसी डिवाइस समूह को संदेश भेजना किसी व्यक्तिगत डिवाइस पर संदेश भेजने के समान है। डिवाइस समूह के लिए अद्वितीय अधिसूचना कुंजी to पैरामीटर सेट करें। इस अनुभाग के उदाहरण दिखाते हैं कि लीगेसी HTTP और XMPP प्रोटोकॉल में डिवाइस समूहों को डेटा संदेश कैसे भेजें।

डिवाइस समूह HTTP पोस्ट अनुरोध

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

डिवाइस समूह HTTP प्रतिक्रिया

यहां "सफलता" का एक उदाहरण दिया गया है - notification_key के साथ 2 पंजीकरण टोकन जुड़े हुए हैं, और संदेश उन दोनों को सफलतापूर्वक भेजा गया था:

{
  "success": 2,
  "failure": 0
}

यहां "आंशिक सफलता" का एक उदाहरण दिया गया है - notification_key के साथ 3 पंजीकरण टोकन जुड़े हुए हैं। संदेश सफलतापूर्वक केवल 1 पंजीकरण टोकन पर भेजा गया था। प्रतिक्रिया संदेश उन पंजीकरण टोकन ( registration_ids ) को सूचीबद्ध करता है जो संदेश प्राप्त करने में विफल रहे:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

जब कोई संदेश notification_key से जुड़े एक या अधिक पंजीकरण टोकन पर वितरित होने में विफल रहता है, तो ऐप सर्वर को पुनः प्रयास के बीच बैकऑफ़ के साथ पुनः प्रयास करना चाहिए।

यदि सर्वर किसी ऐसे डिवाइस समूह को संदेश भेजने का प्रयास करता है जिसमें कोई सदस्य नहीं है, तो प्रतिक्रिया इस तरह दिखती है, 0 सफलता और 0 विफलता के साथ:

{
  "success": 0,
  "failure": 0
}

डिवाइस समूह एक्सएमपीपी संदेश

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

डिवाइस समूह एक्सएमपीपी प्रतिक्रिया

जब संदेश समूह में किसी एक डिवाइस पर सफलतापूर्वक भेजा जाता है, तो XMPP कनेक्शन सर्वर ACK के साथ प्रतिक्रिया करता है। यदि समूह में सभी डिवाइसों पर भेजे गए सभी संदेश विफल हो जाते हैं, तो XMPP कनेक्शन सर्वर NACK के साथ प्रतिक्रिया करता है।

यहां "सफलता" का एक उदाहरण दिया गया है - notification_key के साथ 3 पंजीकरण टोकन जुड़े हुए हैं, और संदेश उन सभी को सफलतापूर्वक भेजा गया था:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

यहां "आंशिक सफलता" का एक उदाहरण दिया गया है - notification_key के साथ 3 पंजीकरण टोकन जुड़े हुए हैं। संदेश सफलतापूर्वक केवल 1 पंजीकरण टोकन पर भेजा गया था। प्रतिक्रिया संदेश उन पंजीकरण टोकन को सूचीबद्ध करता है जो संदेश प्राप्त करने में विफल रहे:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

जब FCM कनेक्शन सर्वर समूह में सभी डिवाइसों तक डिलीवरी करने में विफल रहता है। ऐप सर्वर को एक नैक प्रतिक्रिया प्राप्त होगी।

संदेश विकल्पों की पूरी सूची के लिए, अपने चुने हुए कनेक्शन सर्वर प्रोटोकॉल, HTTP या XMPP के लिए संदर्भ जानकारी देखें।

फायरबेस एडमिन एसडीके लीगेसी भेजने के तरीके

फायरबेस एडमिन नोड.जेएस एसडीके लीगेसी एफसीएम सर्वर एपीआई के आधार पर (एफसीएम) संदेश भेजने के तरीकों का समर्थन करता है। ये विधियाँ send() विधि की तुलना में भिन्न तर्क स्वीकार करती हैं। आपको जब भी संभव हो send() विधि का उपयोग करना चाहिए, और व्यक्तिगत डिवाइस या डिवाइस समूहों को संदेश भेजते समय केवल इस पृष्ठ में वर्णित विधियों का उपयोग करना चाहिए।

अलग-अलग डिवाइस पर भेजें

आप उस डिवाइस पर एक संदेश भेजने के लिए एक पंजीकरण टोकन को sendToDevice() विधि में पास कर सकते हैं:

नोड.जे.एस

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().sendToDevice(registrationToken, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDevice() विधि केवल एक पंजीकरण टोकन के बजाय पंजीकरण टोकन की एक सरणी पास करके एक मल्टीकास्ट संदेश (यानी, एकाधिक डिवाइसों के लिए एक संदेश) भी भेज सकती है:

नोड.जे.एस

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
getMessaging().sendToDevice(registrationTokens, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDevice() विधि एक वादा लौटाती है जिसे एफसीएम से प्रतिक्रिया वाले MessagingDevicesResponse ऑब्जेक्ट के साथ हल किया जाता है। एकल पंजीकरण टोकन या पंजीकरण टोकन की एक श्रृंखला को पास करते समय रिटर्न प्रकार का प्रारूप समान होता है।

प्रमाणीकरण त्रुटि या दर सीमित करने जैसे कुछ मामलों के कारण संपूर्ण संदेश संसाधित होने में विफल हो जाता है। इन मामलों में, sendToDevice() द्वारा लौटाया गया वादा एक त्रुटि के साथ अस्वीकार कर दिया जाता है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, एडमिन एफसीएम एपीआई त्रुटियाँ देखें।

किसी डिवाइस समूह को भेजें

sendToDeviceGroup() विधि आपको उस डिवाइस समूह के लिए अधिसूचना कुंजी निर्दिष्ट करके एक डिवाइस समूह को एक संदेश भेजने की अनुमति देती है:

नोड.जे.एस

// See the "Managing device groups" link above on how to generate a
// notification key.
const notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
getMessaging().sendToDeviceGroup(notificationKey, payload)
  .then((response) => {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDeviceGroup() विधि एक वादा लौटाती है जिसे एफसीएम से प्रतिक्रिया वाले MessagingDevicesResponse ऑब्जेक्ट के साथ हल किया जाता है।

प्रमाणीकरण त्रुटि या दर सीमित करने जैसे कुछ मामलों के कारण संपूर्ण संदेश संसाधित होने में विफल हो जाता है। इन मामलों में, sendToDeviceGroup() द्वारा लौटाया गया वादा एक त्रुटि के साथ अस्वीकार कर दिया जाता है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, एडमिन एफसीएम एपीआई त्रुटियाँ देखें।

संदेश पेलोड को परिभाषित करना

एफसीएम लीगेसी प्रोटोकॉल पर आधारित उपरोक्त विधियां एक संदेश पेलोड को अपने दूसरे तर्क के रूप में स्वीकार करती हैं और अधिसूचना और डेटा संदेश दोनों का समर्थन करती हैं। आप data और/या notification कुंजियों के साथ एक ऑब्जेक्ट बनाकर एक या दोनों संदेश प्रकार निर्दिष्ट कर सकते हैं। उदाहरण के लिए, यहां विभिन्न प्रकार के संदेश पेलोड को परिभाषित करने का तरीका बताया गया है:

अधिसूचना संदेश

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  }
};

डेटा संदेश

const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

संयुक्त संदेश

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};

अधिसूचना संदेश पेलोड में वैध गुणों का एक पूर्वनिर्धारित उपसमूह होता है और आप किस मोबाइल ऑपरेटिंग सिस्टम को लक्षित कर रहे हैं उसके आधार पर थोड़ा भिन्न होता है। पूरी सूची के लिए NotificationMessagePayload के संदर्भ दस्तावेज़ देखें।

डेटा संदेश पेलोड कुछ प्रतिबंधों के साथ कस्टम कुंजी-मूल्य जोड़े से बने होते हैं, जिसमें यह तथ्य भी शामिल है कि सभी मान स्ट्रिंग होने चाहिए। प्रतिबंधों की पूरी सूची के लिए DataMessagePayload के संदर्भ दस्तावेज़ देखें।

संदेश विकल्पों को परिभाषित करना

एफसीएम लीगेसी प्रोटोकॉल पर आधारित उपरोक्त विधियां संदेश के लिए कुछ विकल्प निर्दिष्ट करते हुए एक वैकल्पिक तीसरे तर्क को स्वीकार करती हैं। उदाहरण के लिए, निम्न उदाहरण एक डिवाइस पर उच्च प्राथमिकता वाला संदेश भेजता है जो 24 घंटों के बाद समाप्त हो जाता है:

नोड.जे.एस

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
const payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
const options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
getMessaging().sendToDevice(registrationToken, payload, options)
  .then((response) => {
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

उपलब्ध विकल्पों की पूरी सूची के लिए MessagingOptions के संदर्भ दस्तावेज़ देखें।